Upgrading from a previous version/en - Revision history

FuzzyBot: Updating to match new version of source page

2025-02-25T10:08:04Z

Updating to match new version of source page

@@ Line 13: / Line 13: @@
 =Upgrade instructions (from 2.x or newer to any later version)=
-Please follow these instructions:
+Please follow these steps:
-*Backup your files and database ([[Upgrading from a previous version#Before you start...|did we already mention that?]]).
+#Log out of the administration
-*Delete all the old files/folders except for:
+#Backup your files and database
-**/application/config/security.php -'''Important!! This is the key to all encrypted data in LimeSurvey (version 4 and later)'''
+#Delete all the old files/folders except for:
-**/application/config/config.php;
+##/application/config/security.php - '''Important!! This is the key to all encrypted data in LimeSurvey (version 4 and later)'''
-**/upload directory
+##/application/config/config.php;
-<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>
+<div class="simplebox">[[File:help.png]]'''Note:''' Between major versions (for example from version 3 to 4) the template/design themes change usually completely. Old survey design templates/themes will usually not work anymore.</div>
 = Upgrading using CLI =

FuzzyBot: Updating to match new version of source page

2024-04-03T08:52:36Z

Updating to match new version of source page

← Older revision		Revision as of 10:52, 3 April 2024
Line 111:		Line 111:

	==Survey theme incompatibility==		==Survey theme incompatibility==
			With certain major version updates any custom survey themes will not be compatible, anymore:

	~~Old survey theme are totally incompatible for this version : old theme are totally disabled~~		* Update from LimeSurvey 2.6 or lower to LimeSurvey 2.50
			* Update from LimeSurvey 5.x or lower to LimeSurvey 6.x

	* Update to ~~LimeSurvey 2.6lts or lower~~ to ~~LimeSurvey 2~~.50		==Error "Multiple primary key defined" when updating MySQL database==
	* Update from ~~LimeSurvey 5 or lower to LimeSurvey 6~~.0		If you encounter this error, please check the setting ''sql_generate_invisible_primary_key'' in your MySQL server variables. This is most likely set to ''ON'', but should be set to ''OFF''. Then restore your database from the backup (as explained above) and try again.

FuzzyBot: Updating to match new version of source page

2024-04-02T14:53:19Z

Updating to match new version of source page

← Older revision		Revision as of 16:53, 2 April 2024
Line 109:		Line 109:

	Install version 1.50, import the file, and export the survey structure to the newer .csv format. Then install the latest Version 2.x and import the .csv format and export it to the current .lss format.		Install version 1.50, import the file, and export the survey structure to the newer .csv format. Then install the latest Version 2.x and import the .csv format and export it to the current .lss format.

			==Survey theme incompatibility==

			Old survey theme are totally incompatible for this version : old theme are totally disabled

			* Update to LimeSurvey 2.6lts or lower to LimeSurvey 2.50
			* Update from LimeSurvey 5 or lower to LimeSurvey 6.0

FuzzyBot: Updating to match new version of source page

2021-11-17T16:27:28Z

Updating to match new version of source page

← Older revision		Revision as of 18:27, 17 November 2021
Line 79:		Line 79:
	You can upgrade the database via the PHP CLI: <code>php application/commands/console.php updatedb</code>. This allows you to set up an auto-upgrade system via command line (for example, in a crontab), although it is not recommended.		You can upgrade the database via the PHP CLI: <code>php application/commands/console.php updatedb</code>. This allows you to set up an auto-upgrade system via command line (for example, in a crontab), although it is not recommended.

	= Failed database upgrade =		= Failed database upgrade after manual update/ComfortUpdate=
	Sometimes, even though you did everything correct, things don't work out they are supposed to during database upgrade.		Sometimes, even though you did everything correct, things don't work out they are supposed to during database upgrade.
	That may happen because of various reasons~~, different~~ database ~~version~~, unexpected data ~~format~~ or contents, unusual configurations or anything else that did not show up in our tests (yes, we test ~~alot~~!)		That may happen because of various reasons: Different database versions, unexpected data formats or contents, unusual configurations or anything else that did not show up in our tests (yes, we test a lot!)

	If you have an error during database update and your LimeSurvey instance ends up in an unusable state, you want to go back to the previous version.		If you have an error during database update and your LimeSurvey instance ends up in an unusable state, you want to go back to the previous version.
	This assumes that you still have the database and file backup, either from ~~ComfortUpdate,~~ or ~~you~~ created ~~these manually~~.		This assumes that you still have the database and file backup, either from your regular backup or the one created by Comfortupdate.

	Please execute the following steps:		Please execute the following steps:
Line 98:		Line 98:
	If you run into a problem like this, please always report this in our bug tracker at https://bugs.limesurvey.org		If you run into a problem like this, please always report this in our bug tracker at https://bugs.limesurvey.org

	~~Note:~~ A bug not reported is a bug not fixed. Please don't just rely on other people reporting it. If you see that the bug is already reported, you can also help to raise the bug priority by marking it as 'Yes, this bug affects me' in the bug tracker.		A bug not reported is a bug not fixed. Please don't just rely on other people reporting it. If you see that the bug is already reported, you can also help to raise the bug priority by marking it as 'Yes, this bug affects me' in the bug tracker.

	=FAQ=		=FAQ=

FuzzyBot: Updating to match new version of source page

2021-08-20T07:07:38Z

Updating to match new version of source page

← Older revision		Revision as of 09:07, 20 August 2021
Line 78:		Line 78:

	You can upgrade the database via the PHP CLI: <code>php application/commands/console.php updatedb</code>. This allows you to set up an auto-upgrade system via command line (for example, in a crontab), although it is not recommended.		You can upgrade the database via the PHP CLI: <code>php application/commands/console.php updatedb</code>. This allows you to set up an auto-upgrade system via command line (for example, in a crontab), although it is not recommended.

			= Failed database upgrade =
			Sometimes, even though you did everything correct, things don't work out they are supposed to during database upgrade.
			That may happen because of various reasons, different database version, unexpected data format or contents, unusual configurations or anything else that did not show up in our tests (yes, we test alot!)

			If you have an error during database update and your LimeSurvey instance ends up in an unusable state, you want to go back to the previous version.
			This assumes that you still have the database and file backup, either from ComfortUpdate, or you created these manually.

			Please execute the following steps:

			*Backup the existing LimeSurvey directory and database (yes, again - we will call this the 2nd backup)
			*Restore files to the existing directory (just overwriting them is fine) from the original (1st) backup.
			*Delete the old database and restore the database from the original (1st) backup.

			That's it. Everything should be back to normal.

			'''A note about reporting this issue:'''

			If you run into a problem like this, please always report this in our bug tracker at https://bugs.limesurvey.org

			Note: A bug not reported is a bug not fixed. Please don't just rely on other people reporting it. If you see that the bug is already reported, you can also help to raise the bug priority by marking it as 'Yes, this bug affects me' in the bug tracker.

	=FAQ=		=FAQ=

FuzzyBot: Updating to match new version of source page

2020-03-19T19:50:03Z

Updating to match new version of source page

← Older revision		Revision as of 21:50, 19 March 2020
Line 5:		Line 5:
	<span style='color:#FF0000'>... read this because it is very important: '''Always backup the files and the database of your current installation!'''</span>		<span style='color:#FF0000'>... read this because it is very important: '''Always backup the files and the database of your current installation!'''</span>

	You can do this using a database administration tool like [https://www.phpmyadmin.net 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~~.		You can do this using a database administration tool like [https://www.phpmyadmin.net phpMyAdmin] and a file manager!
			If you don't know how to do this, you should not proceed further and ask someone who knows.

	=The ~~normal~~ way (from 2.x or newer to any later version)=		==Recommendation to use ComfortUpdate==
			'''The easiest/safest way to upgrade is to use our [[ComfortUpdate]] service.'''

			=Upgrade instructions (from 2.x or newer to any later version)=

	Please follow these instructions:		Please follow these instructions:
Line 21:		Line 25:
	*After the upgrade: '''Clear your browser cache and cookies!'''		*After the upgrade: '''Clear your browser cache and cookies!'''

	=~~The thorough way (~~for ~~big version jumps)~~=		=Instructions for older versions=

	Unfortunately, there are a couple of things to consider, so please read the following instructions carefully.		Unfortunately, there are a couple of things to consider, so please read the following instructions carefully.
Line 27:		Line 31:
	==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		*Backup your files and database ([[Upgrading from a previous version#Before you start...\|did we already mention that?]]).
	** 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 [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>~~
	* 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 files of the new 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 will find the database data in the old config.php). 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 ''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.}}
Line 49:		Line 46:
	<div class="simplebox">'''Special checks after an upgrade''':		<div class="simplebox">'''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 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 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 installation. 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		*'''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.
	</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		* Backup your files and database ([[Upgrading from a previous version#Before you start...\|did we already mention that?]]).
	** 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 [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~~
	* 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
Line 75:		Line 68:

	<div class="simplebox">'''Special checks after an upgrade''':		<div class="simplebox">'''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)<br />		*'''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 this permission should be given in the older versions. As this is not perfect, it should be carefully checked.
	</div>		</div>

Line 85:		Line 77:
	= Upgrading using CLI =		= Upgrading using CLI =

	You can upgrade ~~Database~~ via PHP ~~Cli~~: <code>php application/commands/console.php updatedb</code>. This allows you to set up an auto-upgrade system via command line (for example, in a crontab).		You can upgrade the database via the PHP CLI: <code>php application/commands/console.php updatedb</code>. This allows you to set up an auto-upgrade system via command line (for example, in a crontab), although it is not recommended.

	=FAQ=		=FAQ=

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

	~~The last release offering PHP4 support was version 1.82+.~~

	==Can I upgrade even if I have active surveys?==		==Can I upgrade even if I have active surveys?==
Line 97:		Line 85:
	Yes, you can. Exceptions may be mentioned in the thorough instructions above. We strongly advise to test your surveys after upgrade to check if your design templates still work alright.		Yes, you can. Exceptions may be mentioned in the thorough instructions above. We strongly advise to test your surveys after upgrade to check if your design templates still work alright.

	==~~What is the best way~~ to ~~port the~~ *.sql survey structure files ~~of LimeSurvey~~ to the latest version?==		==How to convert .sql/.csv survey structure files to the latest LimeSurvey version?==

	Install version 1.50, import the file, and export the survey structure to the newer .csv format. ~~The~~ latest ~~version can still read~~ the .csv ~~survey structure~~ format.		Install version 1.50, import the file, and export the survey structure to the newer .csv format. Then install the latest Version 2.x and import the .csv format and export it to the current .lss format.

FuzzyBot: Updating to match new version of source page

2020-03-18T13:55:03Z

Updating to match new version of source page

← Older revision		Revision as of 15:55, 18 March 2020
Line 7:		Line 7:
	You can do this using a database administration tool like [https://www.phpmyadmin.net 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.		You can do this using a database administration tool like [https://www.phpmyadmin.net 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.

	=The ~~quick~~ way (~~for minor~~ version ~~changes~~)=		=The normal way (from 2.x or newer to any later version)=

	~~You can use~~ these instructions ~~if you are doing a minor upgrade (for example from 2.00 to 2.01)~~:		Please follow these instructions:
	*Backup your files and database ([[Upgrading from a previous version#Before you start...\|did we already mention that?]]).		*Backup your files and database ([[Upgrading from a previous version#Before you start...\|did we already mention that?]]).
	*Delete all the old files/folders except for:		*Delete all the old files/folders except for:
			**/application/config/security.php -'''Important!! This is the key to all encrypted data in LimeSurvey (version 4 and later)'''
	**/application/config/config.php;		**/application/config/config.php;
	**/upload directory -		**/upload directory
	**/application/config/security.php (when upgrading from 4.x and newer)

	<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>		<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>
Line 20:		Line 20:
	*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.
	*After the upgrade: '''Clear your browser cache and cookies!'''		*After the upgrade: '''Clear your browser cache and cookies!'''


	=The thorough way (for big version jumps)=		=The thorough way (for big version jumps)=

FuzzyBot: Updating to match new version of source page

2020-03-09T13:35:05Z

Updating to match new version of source page

← Older revision		Revision as of 15:35, 9 March 2020
Line 13:		Line 13:
	*Delete all the old files/folders except for:		*Delete all the old files/folders except for:
	**/application/config/config.php;		**/application/config/config.php;
	**/upload directory -		**/upload directory -
			**/application/config/security.php (when upgrading from 4.x and newer)

	<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>		<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.
	*After the upgrade: '''Clear your browser cache and cookies!'''		*After the upgrade: '''Clear your browser cache and cookies!'''


	=The thorough way (for big version jumps)=		=The thorough way (for big version jumps)=

FuzzyBot: Updating to match new version of source page

2018-11-26T18:05:03Z

Updating to match new version of source page

← Older revision		Revision as of 20:05, 26 November 2018
Line 83:		Line 83:
	= Upgrading using CLI =		= Upgrading using CLI =

	You can upgrade Database ~~using~~ PHP Cli ~~using~~ <code>php application/commands/console.php updatedb</code>. This ~~allow~~ you to set up an auto upgrade system ~~only~~ via command line in a crontab ~~for example~~.		You can upgrade Database via PHP Cli: <code>php application/commands/console.php updatedb</code>. This allows you to set up an auto-upgrade system via command line (for example, in a crontab).


	=FAQ=		=FAQ=

FuzzyBot: Updating to match new version of source page

2018-11-01T15:50:03Z

Updating to match new version of source page

← Older revision		Revision as of 17:50, 1 November 2018
Line 80:		Line 80:

	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.		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.

			= Upgrading using CLI =

			You can upgrade Database using PHP Cli using <code>php application/commands/console.php updatedb</code>. This allow you to set up an auto upgrade system only via command line in a crontab for example.


	=FAQ=		=FAQ=