Actions

Major version upgrade: Difference between revisions

From LimeSurvey Manual

No edit summary
Line 35: Line 35:


for self hosted application:
for self hosted application:
# Copy the existing admin theme from the old application to the new application [insert link to admin theme documentation]
# Before it in the new application, make sure the compatibility tag is set correctly: ''https://manual.limesurvey.org/Extension_compatibility#Admin_themes''
# Before
# Copy the existing admin theme from the old application to the new application ''https://manual.limesurvey.org/Custom_Admin_Themes''
# Check the code you customized for the admin theme and update it in accordance with the new version of the application you want to use.
# Check the code you customized for the admin theme and update it in accordance with the new version of the application you want to use.
# After upgrading your old application, by default our new admin theme is now displayed. To update your previously installed admin theme, either:
# After upgrading your old application, by default our new admin theme is now displayed. To update your previously installed admin theme, either:

Revision as of 17:35, 23 August 2023

Notes for specific LimeSurvey versions

LimeSurvey 6

We updated LimeSurvey with a new design, which also includes an upgrade to the Bootstrap version being used for the admin- and surveytheme from Bootstrap 3 to 5.
After this upgrade, all custom survey and adminthemes will be uninstalled and reset to use our new default theme "Fruity TwentyThree", this also affects extended themes.

How to prepare for a major version upgrade

To be on save side when performing an upgrade and be able to continue surveys with the least amount of interruption we reccommend first testing all your customized code on the new version of LimeSurvey oyu wnat to upgrade to.
This will require you to create a new application to test on, you can either create one through our cloud hosting:
https://www.limesurvey.org/
or host one up by yourself:
https://manual.limesurvey.org/Installation_-_LimeSurvey_CE


Custom survey themes

All custom survey themes (this includes extended themes) will be uninstalled and the options configured will be reset to the default.

Upgrade Strategy:

  1. Export the survey theme from the old application
  2. Before importing it in the new application, make sure the compatibility tag is set correctly: https://manual.limesurvey.org/Extension_compatibility#Survey_themes
  3. Import into the new application
  4. Check the code you customized for the survey theme and update it in accordance with the new version of the application you want to use.
  5. Export your updated customized surveytheme from the new application
  6. After upgrading your old application to the new version, the current survey themes will be uninstalled and marked as incompatible.
  7. Now you can delete the old surveytheme and import the new survey theme which you updated. Please ensure you have a backup of the deleted theme.

Custom admin themes

All custom admin themes will be uninstalled and the new default will be used.

for self hosted application:

  1. Before it in the new application, make sure the compatibility tag is set correctly: https://manual.limesurvey.org/Extension_compatibility#Admin_themes
  2. Copy the existing admin theme from the old application to the new application https://manual.limesurvey.org/Custom_Admin_Themes
  3. Check the code you customized for the admin theme and update it in accordance with the new version of the application you want to use.
  4. After upgrading your old application, by default our new admin theme is now displayed. To update your previously installed admin theme, either:
    1. manually update the code of the currently marked as incompatible admin theme
    2. delete the old admin theme and install the new one you previously updated in your test environment

for Cloud users: Please contact our support.

Custom question themes

Custom question themes that do not match the current version cannot be installed, but will still be active after the upgrade.

Upgrade strategy:

  1. try to upload your question theme into the new application
  2. make required changes, so it will be compatible with the new version
  3. after successfully uploading, please check if the question theme is displayed and working as expected.

Custom plugins

Custom plugins that do not match the current version cannot be activated or installed, but will still be active after the upgrade.

Upgrade Strategy:

  1. Check if the plugin can be installed on the new version.
  2. Update the plugin or contact the plugin author to update the plugin.
  3. Manually override the plugin with new files in your application or uninstall the old version and reinstall the new version (all settings will be lost and have to be reapplied)