Upgrading ScrewTurn Wiki from v2 to v3

Modified on Thu, 14 Jan 2010 06:55 by Dario Solera — Categorized as: Help

Upgrading ScrewTurn Wiki from version 2.0 to version 3.0 is easy.


Getting Help

We understand that upgrading might seem a complex task, but in most cases it's simpler than what you think. At any rate, if you are having trouble or you are not sure on what to do, don't hesitate to ask for help in our forum, we'll be happy to provide advice and suggestions.

Note: please take the time to read this page entirely, as it probably contains all the information you need.

File-System Data Storage

If you are using the integrated, file-based data providers, please follow these steps.

  1. Download the File-System Data Storage package.
  2. Backup the entire web application folder (seriously).
  3. Create a file named "app_offline.htm" in the web application folder, so that the application will be taken offline.
  4. Delete all the files in the web application folder, except the "public" directory ("web.config" must also be replaced) and any custom theme you are using (in the Themes folder).
  5. Copy all the new files in the web application folder, except the "public" directory, preserving the existing content.
  6. Edit "web.config", setting your master password (see admin account).
  7. Delete the "app_offline.htm" file created before.
  8. Navigate to the wiki using your browser: the wiki engine will upgrade all your existing files.
  9. Make sure that the wiki configuration is correct in the AdminConfig.aspx page.
  10. Rebuild the search engine index and page links in the AdminHome.aspx page.

Note: your existing plugins will be ignored in the upgraded application because they are not compatible. You can safely delete them in the administration panel. To learn more on v3 plugins, please go the dedicated section.

SQL Server Data Storage

If you are using the SQL Server data providers, please follow these steps. Please note that only SQL Server 2005 and 2008 are supported.

  1. Download the SQL Server Data Storage package.
  2. Backup the entire web application folder and your database (seriously).
  3. Create a file named "app_offline.htm" in the web application folder, so that the application will be taken offline.
  4. Delete all the files in the web application folder, except the "public" directory ("web.config" must also be replaced) and any custom theme you are using (in the Themes folder).
  5. Delete all the files contained in "public\Plugins".
  6. Copy "SqlServerProviders.dll" into "public\Plugins" (the file is in the same directory in the downloaded package).
  7. Copy all the new files in the web application folder, except the "public" directory, preserving the existing content.
  8. Edit "web.config", setting your master password (see admin account) and the database connection string and make sure that the database collation is not case-sensitive (see how to change it).
  9. Delete the "app_offline.htm" file created before.
  10. Navigate to the wiki using your browser: the wiki engine will upgrade all your existing tables and data.
  11. Make sure that the wiki configuration is correct in AdminConfig.aspx (you will probably have to re-enter some values).
  12. In v2 files where not managed by a providers, so you have to migrate Files and related data to the SQL Server Files Storage Provider, as explained here*.
  13. For the same reason, you have to migrate Settings and related data to the SQL Server Settings Storage Provider as explained a the same page linked in the previous step*.
  14. Set the SQL-based providers as default, as explained here*.
  15. Disable the integrated, file-based data providers, as explained in the same page linked in the previous step.
  16. Rebuild the search engine index and page links in the AdminHome.aspx page.

*) These steps are not mandatory, but storing all the data in SQL Server keeps the wiki configuration simpler and cleaner.

MySQL Data Storage

MySQL support is not yet available for ScrewTurn Wiki 3.0.

Mixed Configurations

If you are using a file-system/SQL Server mixed configuration (for example pages are stored in SQL Server and users on the file-system, or the other way round), upgrading is still possible but it is a bit more complicated. Basically, you have to follow the instructions for SQL Server Data Storage (above) and then migrate all the data that is not already in the DB, moving it from the file-based providers to the SQL-based providers. After that, you can set the SQL Server providers are default and completely disable the file-based ones.

Desktop Edition

  1. Download the Desktop Edition package.
  2. Backup the wiki data located in the Physical Directory shown in the Desktop Edition server control panel.
  3. Uninstall the Desktop Edition, instructing the uninstall process to preserve existing data files
  4. Install the new Desktop Edition.
  5. Rebuild the search engine index and page links in the AdminHome.aspx page.