Actions

Upgrading from a previous version/de: Difference between revisions

From LimeSurvey Manual

(Updating to match new version of source page)
(Updating to match new version of source page)
Line 14: Line 14:
**/application/config/config.php;
**/application/config/config.php;
**/upload directory -  
**/upload directory -  
<div class="simplebox">[[File:help.png]]'''Note:''' If you have any customized templates sitting under /upload/templates, make sure you 'refresh' those with any changes that come with the new LimeSurvey version. The easiest way to check for such changes is to file-compare your old template with the new version of the default template. If you see any differences other than your customizations, a refresh is needed.</div>
<div class="simplebox">[[File:help.png]]'''Note:''' If you have any customized templates in /upload/templates, make sure you 'refresh' those with any changes that come with the new LimeSurvey version. The easiest way to check for such changes is to file-compare your old template with the new version of the default template. If you see any differences other than your customizations, a refresh is needed.</div>
*Copy the new files from the new LimeSurvey package to the existing location.
*Copy the new files from the new LimeSurvey package to the existing location.
*Open the admin page in your browser (e.g. https://www.example.com/limesurvey/admin) and check if a database scheme upgrade is necessary.
*Open the admin page in your browser (e.g. https://www.example.com/limesurvey/admin) and check if a database scheme upgrade is necessary.
Line 21: Line 21:
=Der gründliche Weg (für große Versionssprünge)=
=Der gründliche Weg (für große Versionssprünge)=


Unfortunately, there are a couple of things to consider, so please read carefully the following instructions.
Unfortunately, there are a couple of things to consider, so please read the following instructions carefully.


==Upgrading from version 1.50 or later to any later 2.xx version==
==Upgrading from version 1.50 or later to any later 2.xx version==
#[https://www.limesurvey.org/about-limesurvey/download Download] the latest version of LimeSurvey.
*[https://www.limesurvey.org/about-limesurvey/download Download] the latest version of LimeSurvey
# Prepare and backup the old installation:
* Prepare and backup the old installation
## Backup your installation directory files and SQL-based database just in case:
** Backup your installation directory files and SQL-based database just in case
### At the command-line level, make a '''.zip''' or similar archive of the whole installation directory tree of files. For example, in Linux 'tar cvzf foo.tgz cps100' will tar and zip the whole of the cps100 directory;
*** At the command-line level, make a '''.zip''' or similar archive of the whole installation directory tree of files. For example, in Linux 'tar cvzf foo.tgz cps100' will tar and zip the whole cps100 directory
### You can use [httsp://www.phpmyadmin.net phpMyAdmin] to export all tables or you can use the backup database function of LimeSurvey that is available in the Configuration dialog (under the Advanced tab) to backup the entire database;
*** You can use [https://www.phpmyadmin.net phpMyAdmin] to export all tables or you can use the backup database function of LimeSurvey that is available in the configuration dialog (under the advanced tab) to backup the entire database
<div class="simplebox">[[File:help.png]] '''Note:''' Look for the '''LimeSurvey Administration''' button [[File:button-export-sql.png]] to export the database in the older LimeSurvey versions</div>
<div class="simplebox">[[File:help.png]] '''Note:''' Look for the '''LimeSurvey Administration''' button [[File:button-export-sql.png]] to export the database in the older LimeSurvey versions</div>
## Copy your '''config.php''' file, modified '''template''' directories, and the /upload directory separately for quick access later.
* Copy your '''config.php''' file, modified '''template''' directories, and the /upload directory separately for quick access later
# Replace all the installation directory files:
* Replace all the installation directory files
## Delete all old files in the existing installation directory;
** Delete all old files in the existing installation directory
## Upload and unpack the new code version into the same installation directory;
** Upload and unpack the new code version into the same installation directory
## If your previous version is older than 1.90, copy any customized templates to '/upload/templates' - you will also need to rename each template directory whose name matches an existing template in /templates.
** If your previous version is older than 1.90, copy any customized templates to /upload/templates - you will also need to rename each template directory whose name matches an existing template in /templates
## Copy your '/upload' directory back to the old location;
** Copy your /upload directory back to the old location
## Double check the '''permissions''' set on the directories (write access to '''/tmp''', '''/upload''', and their subdirectories is required) as described in the [[Installation#Set directory permissions|installation wiki]];
** Double-check the '''permissions''' set on the directories (write access to '''/tmp''', '''/upload''', and their subdirectories is required) as described in the [[Installation#Set directory permissions|installation wiki]]
## Open http://<yourdomain>/<yourlimesurveydir>/admin in your browser and follow the instructions (you can use the old config.php as reference). The existing database will be automatically detected and if necessary, upgraded after confirmation.
** Open http://<yourdomain>/<yourlimesurveydir>/admin in your browser and follow the instructions (you can use the old config.php as reference). The existing database will be automatically detected and if necessary, upgraded after confirmation
# Check if any special manual checks apply as listed below;
* Check if any special manual checks apply as listed below
# '''Now, clear your browser cache and cookies!''' and you are good to go.
* '''Now, clear your browser cache and cookies(!)''' and you are good to go


{{Alert|title=Attention|text=If you upgrade from e.g. 1.92, it might be necessary to upgrade ''first'' to the latest 1.92 release, then to 2.00, then to 2.06, and then finally to the latest version (e.g. 2.55.x). Read below for [[Upgrading from a previous version#Upgrading from version 1.50 or later to any later 1.xx version|further details]].}}
{{Alert|title=Attention|text=If you upgrade from e.g. 1.92, it might be necessary ''first'' to upgrade to the latest 1.92 release, then to 2.00, then to 2.06, and then finally to the latest version (e.g. 2.55.x). Read below for [[Upgrading from a previous version#Upgrading from version 1.50 or later to any later 1.xx version|further details]].}}


{{Alert|title=Attention|text=Please note that the template structure has changed with the update from 2.0x to 2.50 or later. Your old templates will not be working anymore as the template system is now using responsive templates.}}
{{Alert|title=Attention|text=Please note that the template structure has changed with the update from 2.0x to 2.50 or later. Your old templates will not be working anymore as the template system is now using responsive templates.}}


<div class="simplebox">'''Special checks after an upgrade''':
<div class="simplebox">'''Special checks after an upgrade''':
*'''from any earlier version to 2.xx''':  
*'''from any earlier version to 2.xx''': Proper question codes are mandatory now. After upgrading the installation, check the survey logic of all surveys and correct the codes where necessary
**Proper question codes are mandatory now. After upgrading the installation, check the survey logic of all surveys and correct the codes where necessary.
*'''from a version earlier than v1.53''': When upgrading from a version before v1.53 to the latest version, please check the '''global user rights''' of each user. There was a new '''superadmin''' right introduced in v1.53 that can give a user the same privilege as the master administration account created during the install. The upgrade script is guessing to whom this permission should be given in the older versions.  As this is not perfect, it should be carefully checked
*'''from a version earlier than v1.53''': When upgrading from a version before v1.53 to the latest version, please check the '''global user rights''' of each user. There was a new '''superadmin''' right introduced in v1.53 that can give a user the same privilege as the master administration account created during the install. The upgrade script is guessing to whom should be given this permission in the older versions.  As this is not perfect, it should be carefully checked;
*'''from any earlier version to v2.06''': From 2.05 to 2.06, some unused permissions when editing global permissions for 'surveys' were activated. For example, if a user had only the 'create' permission in 2.05, the other permissions located to the right of 'create' would also get activated with the update to 2.06 (View/read, Update, Delete, Import, Export). Please check whether the admin users got any other global permissions besides the 'original' ones after the update. If yes, please edit them accordingly
*'''from any earlier version to v2.06''': From 2.05 to 2.06, some unused permissions when editing global permissions for 'surveys' were activated. For example, if a user had only the 'create' permission in 2.05, the other permissions located on the right of 'create' would also get activated with the update to 2.06 (View/read, Update, Delete, Import, Export). Please, check whether the admin users got any other global permissions besides the 'original' ones after the update. If yes, please edit them accordingly.
</div>
</div>


==Upgrading from version 1.50 or later to any later 1.xx version==
==Upgrading from version 1.50 or later to any later 1.xx version==
#[https://www.limesurvey.org/about-limesurvey/download Download] the desired version of LimeSurvey.
*[https://www.limesurvey.org/about-limesurvey/download Download] the desired version of LimeSurvey
# Prepare and backup the old installation.
* Prepare and backup the old installation
## Backup your installation directory files and SQL-based database just in case.
** Backup your installation directory files and SQL-based database just in case
### At the command-line level, make a '''.zip''' or similar archive of the whole installation directory tree of files. For example, in Linux 'tar cvzf foo.tgz cps100' will tar and zip the whole of the cps100 directory;
*** At the command-line level, make a '''.zip''' or similar archive of the whole installation directory tree of files. For example, in Linux 'tar cvzf foo.tgz cps100' will tar and zip the whole of the cps100 directory
### Using [httsp://www.phpmyadmin.net phpMyAdmin] or similar to export all tables; or using the '''LimeSurvey Administration''' button [[File:button-export-sql.png]] to backup the entire database.
*** Using [https://www.phpmyadmin.net phpMyAdmin] or similar to export all tables; or using the '''LimeSurvey Administration''' button [[File:button-export-sql.png]] to backup the entire database
## Copy your '''config.php''' file, modified '''template''' directories, and the /upload directory separately for quick access later;
** Copy your '''config.php''' file, modified '''template''' directories, and the /upload directory separately for quick access later
# Replace all the installation directory files:
* Replace all the installation directory files
## Delete all old files in the existing installation directory;
** Delete all old files in the existing installation directory
## Upload and unpack the new code version into the same installation directory;
** Upload and unpack the new code version into the same installation directory
## Edit or replace the '''config.php''' file:
** Edit or replace the '''config.php''' file:
### If your previous version was < 1.70: Edit the new '''config.php''' in order to reflect the changes from the backup '''config.php''' file. '''Do not just overwrite the new '''config.php''' with your old one!''';
*** If your previous version was < 1.70: Edit the new '''config.php''' in order to reflect the changes from the backup '''config.php''' file. '''Do not just overwrite the new '''config.php''' with your old one!'''
### If your previous version was >= 1.70: Simply replace the new '''config.php''' with your backup '''config.php''' file (as the file format has not changed);
*** If your previous version was >= 1.70: Simply replace the new '''config.php''' with your backup '''config.php''' file (as the file format has not changed)
## If your previous version was older than 1.90: Copy any customized templates to '/upload/templates' - you will also need to rename each template directory whose name matches an existing template in /templates;
** If your previous version was older than 1.90: Copy any customized templates to /upload/templates - you will also need to rename each template directory whose name matches an existing template in /templates
## Copy your '/upload' directory back to the old location;
** Copy your /upload directory back to the old location
## Double check the '''permissions''' set on the directories of LimeSurvey (write access to '''/tmp''', '''/upload''', and to their subdirectories is required) as described in the [[Installation#Set Directory permissions|installation wiki]];
** Double-check the '''permissions''' set on the directories of LimeSurvey (write access to '''/tmp''', '''/upload''', and to their subdirectories is required) as described in the [[Installation#Set Directory permissions|installation wiki]]
# Finish the installation/upgrade process:
* Finish the installation/upgrade process
## Once you open the URL to your LimeSurvey administration, the database tables will be updated after confirmation;
** Once you open the URL to your LimeSurvey administration, the database tables will be updated after confirmation
## Remove or rename the '/admin/install' directory as/if instructed by the installation script;
** Remove or rename the /admin/install directory as/if instructed by the installation script
## Check if any special manual checks apply (as listed below).
** Check if any special manual checks apply (as listed below)


<div class="simplebox">'''Spezielle Prüfungen nach einem Update''':
<div class="simplebox">'''Special checks after an upgrade''':
*'''Von einer älteren Version nach 1.92''': Die '''Designvorlagen''' haben sich stark geändert. Bitte überprüfen Sie Ihre angepassten Designvorlagen, ob diese immer noch korrekt funktionieren. Wenn nicht, dann müssen Sie diese anpassen (werden Sie einen Blick auf die Originaltemplates um zu sehen, was sich geändert hat).<br />
*'''from any earlier version to 1.92''': The '''templates''' have been changed. Please check your customized templates if they are still looking right. If not, you will have to edit your templates accordingly (check out the original templates to see what was changed)<br />
*'''Von einer Version älter als v1.53''': Nach dem Update überprüfen Sie bitte die globalen Benutzerrechte, da ein neues Superadmin-Recht eingeführt wurde und während des Updates versucht das Script zu schätzen, wer es bekommen sollte. Das ist nicht immer perfekt, daher sollten die Benutzerrechte noch einmal geprüft werden.</div>
*'''from a version earlier than v1.53''': When upgrading from a version before v1.53 to the latest version, please check the '''global user rights''' of each user. There was a new '''superadmin''' right introduced in v1.53 that can give a user the same privilege as the master administration account created during the install. The upgrade script is guessing to whom this permission should be given in the older versions. As this is not perfect, it should be carefully checked.
</div>


==Aktualisierung von einer Version älter als v1.50 (v1.0 bis 1.44)==
==Aktualisierung von einer Version älter als v1.50 (v1.0 bis 1.44)==


Since the data structure and a lot of other things were changed, '''upgrading from any version previous to v1.50 is <u>NOT</u> possible'''. If you have old survey structure files with a *.sql extension, the only way to get these into a newer version is to install [http://www.limesurvey.org/en/archived-releases/289-limesurvey150zip version 1.50], import the .sql file(s) there, then upgrade that version to the most recent LimeSurvey version. Check the page related to [[Transferring an installation|how an installation can be transferred]] for more details.
Since the data structure and a lot of other things were changed, '''upgrading from any version previous to v1.50 is <u>NOT</u> possible'''. If you have old survey structure files with an *.sql extension, the only way to get these into a newer version is to install [http://www.limesurvey.org/en/archived-releases/289-limesurvey150zip version 1.50], import the .sql file(s) there, then upgrade that version to the most recent LimeSurvey version. Check the page related to [[Transferring an installation|how an installation can be transferred]] for more details.


=Update FAQ=
=Update FAQ=
Line 91: Line 91:
Ja, das ist möglich und bei kleineren Versionssprüngen im Regelfall unbedenklich. Sie sollten in jedem Fall Ihre Umfragen nach dem Update immer testen, vor allen Dingen wenn Sie ein angepasste Designvorlage nutzen.
Ja, das ist möglich und bei kleineren Versionssprüngen im Regelfall unbedenklich. Sie sollten in jedem Fall Ihre Umfragen nach dem Update immer testen, vor allen Dingen wenn Sie ein angepasste Designvorlage nutzen.


==Was ist der beste Weg, um LimeSurvey *.sql-Umfrage Struktur-Dateien auf die neueste Version zu portieren?==
==What is the best way to port the *.sql survey structure files of LimeSurvey to the latest version?==


Installieren Sie die Version 1.50, importieren Sie die Datei und exportieren Sie die UmfragesStruktur als neueres CSV-Format. Die neueste Version kann dieses Format immer noch lesen.
Installieren Sie die Version 1.50, importieren Sie die Datei und exportieren Sie die UmfragesStruktur als neueres CSV-Format. Die neueste Version kann dieses Format immer noch lesen.

Revision as of 17:00, 17 October 2017

Additional pages:{toc}

Bevor Sie beginnen...

... read this because it is very important: Always backup the files and the database of your current installation!

You can do this using a database administration tool like phpMyAdmin and a file manager! If you don't know how to do this, you should not proceed further and ask someone who knows or use the ComfortUpdate instead.

Der schnelle Weg (für kleinere Versionssprünge)

You can use these instructions if you are doing a minor upgrade (for example from 2.00 to 2.01):

  • Backup your files and database (did we already mention that?).
  • Delete all the old files/folders except for:
    • /application/config/config.php;
    • /upload directory -
Note: If you have any customized templates in /upload/templates, make sure you 'refresh' those with any changes that come with the new LimeSurvey version. The easiest way to check for such changes is to file-compare your old template with the new version of the default template. If you see any differences other than your customizations, a refresh is needed.
  • Copy the new files from the new LimeSurvey package to the existing location.
  • Open the admin page in your browser (e.g. https://www.example.com/limesurvey/admin) and check if a database scheme upgrade is necessary.
  • After the upgrade: Clear your browser cache and cookies!

Der gründliche Weg (für große Versionssprünge)

Unfortunately, there are a couple of things to consider, so please read the following instructions carefully.

Upgrading from version 1.50 or later to any later 2.xx version

  • Download the latest version of LimeSurvey
  • Prepare and backup the old installation
    • Backup your installation directory files and SQL-based database just in case
      • At the command-line level, make a .zip or similar archive of the whole installation directory tree of files. For example, in Linux 'tar cvzf foo.tgz cps100' will tar and zip the whole cps100 directory
      • You can use phpMyAdmin to export all tables or you can use the backup database function of LimeSurvey that is available in the configuration dialog (under the advanced tab) to backup the entire database
Note: Look for the LimeSurvey Administration button to export the database in the older LimeSurvey versions
  • Copy your config.php file, modified template directories, and the /upload directory separately for quick access later
  • Replace all the installation directory files
    • Delete all old files in the existing installation directory
    • Upload and unpack the new code version into the same installation directory
    • If your previous version is older than 1.90, copy any customized templates to /upload/templates - you will also need to rename each template directory whose name matches an existing template in /templates
    • Copy your /upload directory back to the old location
    • Double-check the permissions set on the directories (write access to /tmp, /upload, and their subdirectories is required) as described in the installation wiki
    • Open http://<yourdomain>/<yourlimesurveydir>/admin in your browser and follow the instructions (you can use the old config.php as reference). The existing database will be automatically detected and if necessary, upgraded after confirmation
  • Check if any special manual checks apply as listed below
  • Now, clear your browser cache and cookies(!) and you are good to go
  Attention : If you upgrade from e.g. 1.92, it might be necessary first to upgrade to the latest 1.92 release, then to 2.00, then to 2.06, and then finally to the latest version (e.g. 2.55.x). Read below for further details.


  Attention : Please note that the template structure has changed with the update from 2.0x to 2.50 or later. Your old templates will not be working anymore as the template system is now using responsive templates.


Special checks after an upgrade:
  • from any earlier version to 2.xx: Proper question codes are mandatory now. After upgrading the installation, check the survey logic of all surveys and correct the codes where necessary
  • from a version earlier than v1.53: When upgrading from a version before v1.53 to the latest version, please check the global user rights of each user. There was a new superadmin right introduced in v1.53 that can give a user the same privilege as the master administration account created during the install. The upgrade script is guessing to whom this permission should be given in the older versions. As this is not perfect, it should be carefully checked
  • from any earlier version to v2.06: From 2.05 to 2.06, some unused permissions when editing global permissions for 'surveys' were activated. For example, if a user had only the 'create' permission in 2.05, the other permissions located to the right of 'create' would also get activated with the update to 2.06 (View/read, Update, Delete, Import, Export). Please check whether the admin users got any other global permissions besides the 'original' ones after the update. If yes, please edit them accordingly

Upgrading from version 1.50 or later to any later 1.xx version

  • Download the desired version of LimeSurvey
  • Prepare and backup the old installation
    • Backup your installation directory files and SQL-based database just in case
      • At the command-line level, make a .zip or similar archive of the whole installation directory tree of files. For example, in Linux 'tar cvzf foo.tgz cps100' will tar and zip the whole of the cps100 directory
      • Using phpMyAdmin or similar to export all tables; or using the LimeSurvey Administration button to backup the entire database
    • Copy your config.php file, modified template directories, and the /upload directory separately for quick access later
  • Replace all the installation directory files
    • Delete all old files in the existing installation directory
    • Upload and unpack the new code version into the same installation directory
    • Edit or replace the config.php file:
      • If your previous version was < 1.70: Edit the new config.php in order to reflect the changes from the backup config.php file. Do not just overwrite the new config.php with your old one!
      • If your previous version was >= 1.70: Simply replace the new config.php with your backup config.php file (as the file format has not changed)
    • If your previous version was older than 1.90: Copy any customized templates to /upload/templates - you will also need to rename each template directory whose name matches an existing template in /templates
    • Copy your /upload directory back to the old location
    • Double-check the permissions set on the directories of LimeSurvey (write access to /tmp, /upload, and to their subdirectories is required) as described in the installation wiki
  • Finish the installation/upgrade process
    • Once you open the URL to your LimeSurvey administration, the database tables will be updated after confirmation
    • Remove or rename the /admin/install directory as/if instructed by the installation script
    • Check if any special manual checks apply (as listed below)
Special checks after an upgrade:
  • from any earlier version to 1.92: The templates have been changed. Please check your customized templates if they are still looking right. If not, you will have to edit your templates accordingly (check out the original templates to see what was changed)
  • from a version earlier than v1.53: When upgrading from a version before v1.53 to the latest version, please check the global user rights of each user. There was a new superadmin right introduced in v1.53 that can give a user the same privilege as the master administration account created during the install. The upgrade script is guessing to whom this permission should be given in the older versions. As this is not perfect, it should be carefully checked.

Aktualisierung von einer Version älter als v1.50 (v1.0 bis 1.44)

Since the data structure and a lot of other things were changed, upgrading from any version previous to v1.50 is NOT possible. If you have old survey structure files with an *.sql extension, the only way to get these into a newer version is to install version 1.50, import the .sql file(s) there, then upgrade that version to the most recent LimeSurvey version. Check the page related to how an installation can be transferred for more details.

Update FAQ

What is the most recent LimeSurvey version that still supports PHP4?

Die letzte Version, die PHP4 unterstützt, ist Version 1.82+

Kann ich auch updaten, wenn ich aktive Umfragen habe?

Ja, das ist möglich und bei kleineren Versionssprüngen im Regelfall unbedenklich. Sie sollten in jedem Fall Ihre Umfragen nach dem Update immer testen, vor allen Dingen wenn Sie ein angepasste Designvorlage nutzen.

What is the best way to port the *.sql survey structure files of LimeSurvey to the latest version?

Installieren Sie die Version 1.50, importieren Sie die Datei und exportieren Sie die UmfragesStruktur als neueres CSV-Format. Die neueste Version kann dieses Format immer noch lesen.