Installation Update

Each SoSci Survey installation package is also an update package at the same time. If this is yet to be done, download the latest installation package in the Download-Portal. You need your license data (password) in order to download this.

For the provision of interim versions and important security updates we provide a direct download link (via https://www.soscisurvey.de/owc/).

After the update is complete, SoSci Survey can be accessed as usual. The new version number will be displayed on the left in the navigation.

Programs, databases and caching is not consistent internally during the update. This means that SoSci Survey cannot be used for project management or to fill out questionnaires during the update. If this is done, the user may get error messages listed in the log files (system/logfiles). This can also lead to data being lost during the update.

The server should be blocked when carrying out the update in order to avoid problems such as these.

Server Management → Server Maintenance → Block Server

Note: If you are using version 2.4.00 or more recent, the write cache contents is automatically written to the database when the server is blocked. If this is the case, you can skip this step.

If you have enabled write cache (Server Management → Server Settings → Write cache, transfer the contents of the cache into the database before carrying out the update. This is important as the file format in the cache can be changed during the update.

Server Management → Server Maintenance → Write cache.

In principle, it always makes sense to create a backup of the file system and the database before carrying out an update. If there are any unforeseen problems, the files can then be returned to their original state.

If you are using Linux and a MySQL database, you can use the following Bash script to create backups. The file paths, along with the database name and password obviously have to be customized to your installation. In order for the file to be executed, the execute flag for the script has to be used with chmod after saving.

backup4update.sh

#!/bin/sh
 
#Backup Settings
pathSOSCI=/var/www/html/sosci
pathBACKUP=/var/www/backup
dbDatabase=sosci
dbUser=survey
dbPass=PASSWORD
 
# Timestamp for the File Name
datetime=`date +%Y-%m-%d_%H-%M-%S`
 
#File System Backup
tar --exclude=$pathSOSCI/system/session --exclude=$pathSOSCI/system/cache -czf $pathBACKUP/sosci-html-$datetime.tar.gz $pathSOSCI
 
#MySQL Database Backup
mysqldump -u$dbUser -p$dbPass -q --databases $dbDatabase | gzip -9 > $pathBACKUP/sosci-database-$datetime.sql.gz

Unzip the installation packet in a directory on the local computer (not in the SoSci Survey installation directory directly). Replace the following directories in the SoSci Survey installation directory with the new files from the update package:

• /admin
• /help
• /images
• /inc
• /layout
• /lib
• /modules
• /plugins
• /script
• /templates
• /spellcheck.php (Datei)

Only copy files, do not delete any files from this folder:

• /plugins – There can be files here that are not included in the update (anymore). Therefore, do not delete any files from this directory.

Do not copy or delete any files from/to the following directories:

• /system – This directory contains the installation configuration and must not be changed during the update.
• All other directories: The (sometimes numerous) project directories must not be changed or deleted, otherwise ongoing projects may not longer be available after the update. You can check in Server Management → Server Maintenance → Directories whether there are potentially deserted directories on the server.

The files in the root directory are optional: they control what is displayed in the browser (index.html) when the directories are accessed, how search engines deal with installation (robots.txt), and which symbol is displayed in the browser's tab bar (favicon.ico). These files can be customized or replaced if needed. If you have not made any modifications to these files, then you can update them during the update.

Note: To upload the new files you require, like with the installation, a FTP program (e.g. FileZilla), or another way to copy files onto the webserver. At the moment, an update cannot be triggered directly from SoSci Survey is not possible.

After the files have been updated, the installation routine (admin/install.php) should always be called up. This ensures the database will be updated and points to any potential problems at the same time.

Tip: If you have blocked the server, calling up the Server Installation Routine will be offered directly on the corresponding page (version 2.4.00 onwards).

Call the http://www.domain.tld/sosci/admin/install.php URL in the internet browser. Please adjust the domain and the SoSci Survey directory in the URL according to your installation.

After the installation is complete, the server will automatically be unblocked.