Actions

Difference between revisions of "Installation - LimeSurvey CE"

From LimeSurvey Manual

(fileinfo)
 
(45 intermediate revisions by 9 users not shown)
Line 3: Line 3:
  
 
<!--T:2-->
 
<!--T:2-->
 +
__TOC__
 +
 +
<!--T:52-->
 
<div class="simplebox"> Note: These installation instructions are for version 2.0 or later. Older instructions for 1.92 can be found [[Installation Version 1.92 or older|here]] and update instructions can be found [[Upgrading from a previous version|here]]. </div>
 
<div class="simplebox"> Note: These installation instructions are for version 2.0 or later. Older instructions for 1.92 can be found [[Installation Version 1.92 or older|here]] and update instructions can be found [[Upgrading from a previous version|here]]. </div>
  
Line 9: Line 12:
 
<!--T:4-->
 
<!--T:4-->
 
The LimeSurvey project provides two ways to install LimeSurvey:
 
The LimeSurvey project provides two ways to install LimeSurvey:
*On your webserver:<br />In that case just follow the instructions on this page starting with step 1.
+
*On your webserver:<br />In this case, just follow the instructions on this page starting with step 1.
  
 
<!--T:5-->
 
<!--T:5-->
*On your local Windows PC:<br />You usually only want to install LimeSurvey on your local PC if you want to create surveys locally (mainly for speed or development/test reasons) and upload them later to your live LimeSurvey installation on a web server. We have prepared for this a special package for LimeSurvey which includes the web server, the database and the LimeSurvey application and [[Installation of the LimeSurvey XAMPP package|instructions how to install it]].
+
*On your local Windows PC:<br />You usually only want to install LimeSurvey on your local PC if you want to create surveys locally (mainly for speed or development/test reasons) and upload them later to your live LimeSurvey installation on a web server. For this purpose, we have prepared a special LimeSurvey package which includes the web server, the database, the LimeSurvey application, and [[Installation of the LimeSurvey XAMPP package|instructions how to install it]].
  
 
=Make sure you can use LimeSurvey on your website= <!--T:7-->
 
=Make sure you can use LimeSurvey on your website= <!--T:7-->
  
 
<!--T:8-->
 
<!--T:8-->
Make sure your server meets the following additional requirements. Most of these requirements will also be checked during the installation.
+
Make sure your server meets the following additional requirements.
  
 +
<!--T:51-->
 
{{Note|The minimum set of requirements will also be checked during the installation process!}}
 
{{Note|The minimum set of requirements will also be checked during the installation process!}}
  
 
<!--T:9-->
 
<!--T:9-->
 
The minimum set of requirements:
 
The minimum set of requirements:
* Minimum 180MB disk space
+
* Minimum 250 MB disk space.
* MySQL 5.5.3 or later '''OR''' Microsoft SQL Server 2005 or later '''OR''' Postgres 9 or later
+
* MySQL 5.5.3 or later '''OR''' Microsoft SQL Server 2005 or later '''OR''' Postgres 9 or later.
* Minimum PHP 5.4 or later, however we recommend PHP 5.6.x or later with the following modules/libraries enabled:
+
* Minimum PHP 5.5.9 or later; however, we recommend PHP 7.0.0+ with the following modules/libraries enabled:
** mbstring (Multibyte String Functions) extension library (see also [[Installation FAQ#What is this mbstring (Multibyte String Functions) library?|Installation FAQ]])
+
** [[Installation FAQ#Requirements page#What is the mbstring (Multibyte String Functions) library|mbstring (Multibyte String Functions)]] extension library.
** PDO database driver for MySQL (pdo_mysql or pdo_mysqli) or Postgres (pdo_pgsql) or MSSQL ([https://php.net/manual/en/ref.pdo-sqlsrv.php pdo_sqlsrv] for Windows and [http://www.php.net/manual/en/ref.pdo-dblib.php pdo_dblib] for Linux)
+
** PDO database driver for MySQL (pdo_mysql or pdo_mysqli) or Postgres (pdo_pgsql) or MSSQL ([https://php.net/manual/en/ref.pdo-sqlsrv.php pdo_sqlsrv] for Windows and [http://www.php.net/manual/en/ref.pdo-dblib.php pdo_dblib] for Linux).
** Also, we assume in general that all PHP default libraries are enabled (like hash, session, etc.).
+
** Also, we assume in general that all PHP default libraries are enabled  
 
+
*** hash
<!--T:10-->
+
*** session
<div class="simplebox"> Note: LimeSurvey 2.x uses different database drivers than 1.x . If you get a message not No DBO driver was found during the installation, you will have to contact your webspace provider and ask them to activate one of the aforementioned database driver libraries. </div>
+
*** openssl or mcrypt
 +
*** fileinfo
 +
*** etc …
  
 
<!--T:47-->
 
<!--T:47-->
<div class="simplebox"> Note: If you are connecting from Linux to a MSSQL database on a Windows server using the dblib PDO driver, then the underlying FreeTDS needs to be set up correctly. Check out the [[Troubleshooting]] page for more info.</div>
+
<div class="simplebox"> Note: If you are connecting from Linux to a MSSQL database on a Windows server using the dblib PDO driver, then the underlying FreeTDS needs to be set up correctly. Check out the [[Troubleshooting]] page for more information.</div>
  
 
<!--T:11-->
 
<!--T:11-->
 
Optional PHP Extensions:
 
Optional PHP Extensions:
* '''GD-Library''' '''with FreeType support''' installed is needed for captchas or nice charts in statistics - see [https://php.net/manual/image.setup.php PHP GD-Library Extension documentation]
+
* '''GD-Library''' '''with FreeType support''' installed is needed for captchas, nice charts in statistics or to upload images via the HTML editor - see [https://php.net/manual/image.setup.php PHP GD-Library Extension documentation]
* '''IMAP''' (pretty standard) is needed for the [[Email bounce tracking system]] - see [https://php.net/manual/imap.setup.php PHP IMAP Extension documentation]
+
* '''IMAP''' (pretty standard) is needed for the [[Email bounce tracking system|email bounce tracking system]] - see [https://php.net/manual/imap.setup.php PHP IMAP Extension documentation]
* '''LDAP''' installed is needed to import tokens using LDAP - see [https://secure.php.net/manual/en/book.ldap.phpp PHP LDAP Documentation]
+
* '''LDAP''' installed is needed to import survey participants using LDAP - see [https://php.net/manual/en/book.ldap.php PHP LDAP Documentation]
* '''Zip''' (pretty standard) for template upload and import resources Zip archives - see [https://php.net/manual/zip.setup.php PHP Zip Extension documentation]
+
* '''Zip''' (pretty standard) is needed for template upload, import of .zip archived resources, and excel export - see [https://php.net/manual/zip.setup.php PHP Zip Extension documentation]
 
* '''Zlib''' (pretty standard) is needed for the [[ComfortUpdate]] - see [https://php.net/manual/zlib.setup.php PHP Zlib Extension documentation]
 
* '''Zlib''' (pretty standard) is needed for the [[ComfortUpdate]] - see [https://php.net/manual/zlib.setup.php PHP Zlib Extension documentation]
  
 
<!--T:12-->
 
<!--T:12-->
In most cases, your webspace provider or system administrator will be able to help you out on these optional components.
+
In most cases, your web server provider or system administrator will be able to help you out with these optional components.
  
 
<!--T:14-->
 
<!--T:14-->
If you want to run Microsoft's IIS server, taking a look at "[[Installation on XP with IIS]] might also help.
+
If you want to run Microsoft's IIS server, taking a look at [[Installation on XP with IIS]] might also help.
  
 
===Browser compatibility=== <!--T:46-->
 
===Browser compatibility=== <!--T:46-->
'''For the survey-taking side''', we currently support IE9 and all newer comparable browsers like FF, Chrome, Opera, etc. with activated JavaScript.
+
'''For the survey-taking side''', we currently support IE11 (intranet-mode excluded) and all newer comparable browsers like Edge, FF, Chrome, Opera etc. with activated JavaScript.  
'''For the administration part''', we currently support IE11 and all newer comparable browsers like FF, Chrome, Opera, etc. with activated JavaScript.
+
 
We do not support any IE version running in Intranet-mode or Compatibility-mode!
+
<!--T:53-->
 +
'''For the administration part''', we currently support Edge and all newer comparable browsers like FF, Chrome, Opera etc. with activated JavaScript. <u>We do not support any Internet Explorer versions in the administration part anymore.</u>
  
 
==Screen sizes== <!--T:48-->
 
==Screen sizes== <!--T:48-->
Line 62: Line 69:
  
 
<!--T:16-->
 
<!--T:16-->
LimeSurvey should work with most hosting companies that provide PHP and MYSQL. If you want a ready-installed version of LimeSurvey, [https://www.limesurvey.org/editions-and-prices/limesurvey-pro/editions-and-prices-professional LimeSurvey Professional], else check out our [[LimeSurvey-compatible hosting companies|list of LimeSurvey-compatible hosting companies]].
+
LimeSurvey should work with most hosting companies that provide PHP and MySQL. If you want a ready-installed version of LimeSurvey, you could try [https://www.limesurvey.org/editions-and-prices/limesurvey-pro/editions-and-prices-professional LimeSurvey Professional], else check out our [[LimeSurvey-compatible hosting companies|list of LimeSurvey-compatible hosting companies]].
  
 
=Download the LimeSurvey package= <!--T:17-->
 
=Download the LimeSurvey package= <!--T:17-->
Line 72: Line 79:
  
 
<!--T:20-->
 
<!--T:20-->
Uncompress the zip file into a dedicated directory/folder using your preferred compression software. When you uncompress the file make sure that you uncompress the directory structure with the files (this is default behavior for most compression programs). The path name for the installation directory should not include '''(''' or ''')''' characters, but may include the '''space''' character
+
Uncompress the zip file into a dedicated directory/folder using your preferred compression software. When you uncompress the file make sure that you uncompress the directory structure with the files (this is default behavior for most compression programs). The path name for the installation directory should not include '(' or ')' special characters, but it may include the '''space''' character.
  
 
=Collect information about your server= <!--T:21-->
 
=Collect information about your server= <!--T:21-->
Line 78: Line 85:
 
<!--T:22-->
 
<!--T:22-->
 
You will need to know the following things to install LimeSurvey on your web server correctly:
 
You will need to know the following things to install LimeSurvey on your web server correctly:
*Your intended website URL where your scripts will reside (e.g: ''http://my.domain.com/limesurvey'')
+
*Your intended website URL where your scripts will reside (e.g. ''http://my.domain.com/limesurvey'').
*The physical disk location on your server where your scripts will reside (e.g.: ''/home/usr/htdocs/limesurvey'')
+
*The physical disk location on your server where your scripts will reside (e.g. ''/home/usr/htdocs/limesurvey'').
*The IP/net location of your database server (ie: ''localhost'')
+
*The IP/net location of your database server (i.e. ''localhost'').
 
*If your database server uses a non-standard port, find out which port it is.
 
*If your database server uses a non-standard port, find out which port it is.
*Your user name and password for your database server
+
*Your user name and password for your database server.
 
*With most providers you can't let the script create the database, but have to do it yourself.  If you are using such a provider, please create a database (for example ''limesurvey'') yourself.
 
*With most providers you can't let the script create the database, but have to do it yourself.  If you are using such a provider, please create a database (for example ''limesurvey'') yourself.
  
Line 88: Line 95:
  
 
<!--T:24-->
 
<!--T:24-->
Using your FTP program, connect to your web server and create a directory to store your scripts. Then upload the files using the directory structure they are in. Make sure you '''upload the files in binary mode''' (check the settings of your FTP program). Please note that uploading in ASCII mode can lead to uncommon errors (e.g. 'class not found' error during installation), also images may not be uploaded correctly.
+
Using your FTP program (e.g. FileZilla), connect to your web server and create a directory to store your scripts. Then upload the files using the directory structure they are in. Make sure you '''upload the files in binary mode''' (check the settings of your FTP program). Please note that uploading in ASCII mode can lead to uncommon errors (e.g. 'class not found' error during installation), also images may not be uploaded correctly.
  
 
=Set directory permissions= <!--T:25-->
 
=Set directory permissions= <!--T:25-->
Line 100: Line 107:
  
 
<!--T:27-->
 
<!--T:27-->
{{Hint|Text=If you are using Linux, then setting permissions depends on your webserver configuration. For example, using Apache HTTPD on CentOS, use '''chmod -R 755 <directory> ; chown -R apache <directory>'''. This will give everyone access to read, and your webserver will have permission to write. For more information on Linux permissions, see https://www.linux.com/learn/tutorials/309527-understanding-linux-file-permissions}}
+
{{Alert|If you are using Linux, then setting permissions depends on your webserver configuration. For example, if you use Apache HTTPD on CentOS, type '''chmod -R 755 <directory> ; chown -R apache <directory>'''. This will give everyone access to read, and your webserver will have the permission to write. Check the [https://www.linux.com/learn/tutorials/309527-understanding-linux-file-permissions following link] for more information on Linux permissions.}}
  
 
=Create a database user= <!--T:28-->
 
=Create a database user= <!--T:28-->
  
 
<!--T:29-->
 
<!--T:29-->
LimeSurvey will create a database and the tables inside it. To be able to do this, it will need the user name and password of a database user. We generally recommend to create a database user with the following permissions:
+
LimeSurvey will create a database and the tables inside it. To be able to do this, it will need the user name and password of a database user. We generally recommend creating a database user with the following permissions:
  
 
<!--T:30-->
 
<!--T:30-->
Line 114: Line 121:
  
 
<!--T:32-->
 
<!--T:32-->
- Microsoft SQL Server: Unknown - if you can find out this information please complete it.
+
- Microsoft SQL Server: ''Unknown - if you can find out this information, please complete it''.
  
 
=Run the installation script= <!--T:33-->
 
=Run the installation script= <!--T:33-->
  
 
<!--T:34-->
 
<!--T:34-->
'''Go to "http://www.example.com/limesurvey/admin"'''. If you configured everything correctly, the LimeSurvey installer should be starting - just follow the instructions. You will be asked if to create the database and/or create the tables inside the database. LimeSurvey will then create the needed tables in the database.
+
'''Go to "example.org/limesurvey/admin"'''. If you configured everything correctly, the LimeSurvey installer should be starting - just follow the instructions. You will be asked whether you wish to create the database and/or create the tables inside the database. LimeSurvey will then create the needed tables in the database.
  
 
=Connect to the administration script for the first time= <!--T:35-->
 
=Connect to the administration script for the first time= <!--T:35-->
  
 
<!--T:36-->
 
<!--T:36-->
After the installer has finished you are done! Open your browser and enter the URL to the LimeSurvey administration. Assuming you used 'limesurvey' as the directory name to store the files in, this will be something like "http://www.example.com/limesurvey/admin".
+
You are done when the installation finishes! Open your browser and enter the URL to the LimeSurvey administration. Assuming you used 'limesurvey' as the directory name to store the files in, this will be something like "http://www.example.com/limesurvey/admin".
  
 
<!--T:37-->
 
<!--T:37-->
You should get a login screen. The default login credentials (if not changed during in the installation) are
+
You should get a login screen. The default login credentials (if they have not been changed during the installation) are:
 
 
  
 
<!--T:38-->
 
<!--T:38-->
Line 139: Line 145:
 
<!--T:50-->
 
<!--T:50-->
 
</syntaxhighlight>
 
</syntaxhighlight>
 
  
 
<!--T:41-->
 
<!--T:41-->
 
You will be prompted to change the default password after you logged in. Have fun!
 
You will be prompted to change the default password after you logged in. Have fun!
 +
 +
=Further configuration= <!--T:54-->
 +
 +
==Caching== <!--T:55-->
 +
 +
<!--T:56-->
 +
LimeSurvey uses the Yii file cache by default, but it can be configured to use other cache engines. Possible other caches are:
 +
 +
<!--T:57-->
 +
* Memcached
 +
* Redis
 +
* WinCache
 +
* XCache
 +
 +
<!--T:58-->
 +
Please see the [https://www.yiiframework.com/doc/api/1.1/CCache Yii documentation] for full description.
 +
 +
<!--T:59-->
 +
Since LimeSurvey 4.0.0 you also have the possibility to cache calculations in the Expression Manager. This can provide a significant speed-up depending on survey complexity. To enable the emcache, add this in your config.php file (components array):
 +
 +
<!--T:60-->
 +
<syntaxhighlight lang="php">
 +
'emcache' => array('class' => 'CFileCache'),
 +
</syntaxhighlight>
 +
 +
<!--T:61-->
 +
As with the main Yii cache, other cache systems can be used.
 +
 +
<!--T:62-->
 +
{{Note| The emcache is not compatible with randomized surveys, and will be automatically turned off in such cases.}}
  
 
=What if I have problems...= <!--T:42-->
 
=What if I have problems...= <!--T:42-->

Latest revision as of 10:44, 28 June 2019

Other languages:
Deutsch • ‎English • ‎español • ‎français • ‎italiano • ‎日本語 • ‎Nederlands • ‎occitan • ‎polski • ‎português do Brasil • ‎русский • ‎slovenščina • ‎Türkçe • ‎中文(中国大陆)‎ • ‎中文(繁體)‎
Note: These installation instructions are for version 2.0 or later. Older instructions for 1.92 can be found here and update instructions can be found here.

General

The LimeSurvey project provides two ways to install LimeSurvey:

  • On your webserver:
    In this case, just follow the instructions on this page starting with step 1.
  • On your local Windows PC:
    You usually only want to install LimeSurvey on your local PC if you want to create surveys locally (mainly for speed or development/test reasons) and upload them later to your live LimeSurvey installation on a web server. For this purpose, we have prepared a special LimeSurvey package which includes the web server, the database, the LimeSurvey application, and instructions how to install it.

Make sure you can use LimeSurvey on your website

Make sure your server meets the following additional requirements.

Help.pngThe minimum set of requirements will also be checked during the installation process!

The minimum set of requirements:

  • Minimum 250 MB disk space.
  • MySQL 5.5.3 or later OR Microsoft SQL Server 2005 or later OR Postgres 9 or later.
  • Minimum PHP 5.5.9 or later; however, we recommend PHP 7.0.0+ with the following modules/libraries enabled:
    • mbstring (Multibyte String Functions) extension library.
    • PDO database driver for MySQL (pdo_mysql or pdo_mysqli) or Postgres (pdo_pgsql) or MSSQL (pdo_sqlsrv for Windows and pdo_dblib for Linux).
    • Also, we assume in general that all PHP default libraries are enabled
      • hash
      • session
      • openssl or mcrypt
      • fileinfo
      • etc …
Note: If you are connecting from Linux to a MSSQL database on a Windows server using the dblib PDO driver, then the underlying FreeTDS needs to be set up correctly. Check out the Troubleshooting page for more information.

Optional PHP Extensions:

In most cases, your web server provider or system administrator will be able to help you out with these optional components.

If you want to run Microsoft's IIS server, taking a look at Installation on XP with IIS might also help.

Browser compatibility

For the survey-taking side, we currently support IE11 (intranet-mode excluded) and all newer comparable browsers like Edge, FF, Chrome, Opera etc. with activated JavaScript.

For the administration part, we currently support Edge and all newer comparable browsers like FF, Chrome, Opera etc. with activated JavaScript. We do not support any Internet Explorer versions in the administration part anymore.

Screen sizes

We support any reasonable screen size for survey taking (360px x 640px and up). The minimum supported screen resolution for the LimeSurvey administration page is 1280px x 1024px.

Hosting for LimeSurvey

LimeSurvey should work with most hosting companies that provide PHP and MySQL. If you want a ready-installed version of LimeSurvey, you could try LimeSurvey Professional, else check out our list of LimeSurvey-compatible hosting companies.

Download the LimeSurvey package

Download the latest stable LimeSurvey zip package (there are also gzip, bz2 and 7zip packages available for your convenience) and save it to your local disk.

Unpack the LimeSurvey package

Uncompress the zip file into a dedicated directory/folder using your preferred compression software. When you uncompress the file make sure that you uncompress the directory structure with the files (this is default behavior for most compression programs). The path name for the installation directory should not include '(' or ')' special characters, but it may include the space character.

Collect information about your server

You will need to know the following things to install LimeSurvey on your web server correctly:

  • Your intended website URL where your scripts will reside (e.g. http://my.domain.com/limesurvey).
  • The physical disk location on your server where your scripts will reside (e.g. /home/usr/htdocs/limesurvey).
  • The IP/net location of your database server (i.e. localhost).
  • If your database server uses a non-standard port, find out which port it is.
  • Your user name and password for your database server.
  • With most providers you can't let the script create the database, but have to do it yourself. If you are using such a provider, please create a database (for example limesurvey) yourself.

Upload the files to your web server

Using your FTP program (e.g. FileZilla), connect to your web server and create a directory to store your scripts. Then upload the files using the directory structure they are in. Make sure you upload the files in binary mode (check the settings of your FTP program). Please note that uploading in ASCII mode can lead to uncommon errors (e.g. 'class not found' error during installation), also images may not be uploaded correctly.

Set directory permissions

For the script to work properly it needs certain access to some directories - this applies especially to Linux/*nix systems.

  • The "/limesurvey/tmp" directory (and all its subdirectories and files) are used for imports & uploads and should be set to Read & Write for your webserver.
  • The "/limesurvey/upload/" directory (and all its subdirectories and files) must also have Read & Write for your webserver in order to enable picture and media files upload.
  • The "/limesurvey/application/config/" directory also needs Read & Write permissions for your webserver.
  • The other directories can be set to Read Only. You may wish in Linux/Unix to set the permissions on each file within the /limesurvey/admin directory to Read Only.
Important.png
If you are using Linux, then setting permissions depends on your webserver configuration. For example, if you use Apache HTTPD on CentOS, type chmod -R 755 <directory> ; chown -R apache <directory>. This will give everyone access to read, and your webserver will have the permission to write. Check the following link for more information on Linux permissions.

Create a database user

LimeSurvey will create a database and the tables inside it. To be able to do this, it will need the user name and password of a database user. We generally recommend creating a database user with the following permissions:

- MySQL: SELECT, CREATE, INSERT, UPDATE, DELETE, ALTER, DROP, INDEX

- PostgreSQL: SELECT, INSERT, UPDATE, DELETE, TRUNCATE, TRIGGER

- Microsoft SQL Server: Unknown - if you can find out this information, please complete it.

Run the installation script

Go to "example.org/limesurvey/admin". If you configured everything correctly, the LimeSurvey installer should be starting - just follow the instructions. You will be asked whether you wish to create the database and/or create the tables inside the database. LimeSurvey will then create the needed tables in the database.

Connect to the administration script for the first time

You are done when the installation finishes! Open your browser and enter the URL to the LimeSurvey administration. Assuming you used 'limesurvey' as the directory name to store the files in, this will be something like "http://www.example.com/limesurvey/admin".

You should get a login screen. The default login credentials (if they have not been changed during the installation) are:

User: admin
Password: password

You will be prompted to change the default password after you logged in. Have fun!

Further configuration

Caching

LimeSurvey uses the Yii file cache by default, but it can be configured to use other cache engines. Possible other caches are:

  • Memcached
  • Redis
  • WinCache
  • XCache

Please see the Yii documentation for full description.

Since LimeSurvey 4.0.0 you also have the possibility to cache calculations in the Expression Manager. This can provide a significant speed-up depending on survey complexity. To enable the emcache, add this in your config.php file (components array):

'emcache' => array('class' => 'CFileCache'),

As with the main Yii cache, other cache systems can be used.

Help.png The emcache is not compatible with randomized surveys, and will be automatically turned off in such cases.

What if I have problems...

Like all computer programs, most of the time things will work just like the instructions say, but sometimes they just won't. There are too many possible reasons for things not going according to plan to describe here. If you have trouble, first check out the Installation FAQ. If you don't find your answer there, please post your problem and any error messages in the LimeSurvey forums, open a support ticket, or join the IRC channel: