LimeSurvey Manual - User contributions [en]

ComfortUpdate

2017-04-01T04:07:29Z

Regexaurus:

<languages />
<translate>

__TOC__

=General= 


The ComfortUpdate tool is a LimeSurvey professional service to update your installation of LimeSurvey easily from your web browser, with just a few mouse clicks - instead of having to perform [[Upgrading from a previous version|a manual update]].


To use and test ComfortUpdate you will have to register [https://www.limesurvey.org/en/services#pricing with our website] to receive a free trial key. After that trial key has expired you can either [https://www.limesurvey.org/en/services#pricing buy one of our premium packages] or [[Upgrading from a previous version|update your installation manually]].

=Requirements= 


Your PHP installation must be compiled with support for ZLib. Check your PHPInfo to see, and contact your system administrator to confirm. [http://php.net/manual/es/book.zlib.php].


Your server must be able to connect by SSL to update.limesurvey.org and update-data.limesurvey.org in order to use the ComfortUpdate tool. If you have problems with this and get error messages like


10060 could not connect to the host "update.limesurvey.org"
you should tweak/edit your proxy/firewall security settings or ask your server administrator for help.

=Using ComfortUpdate= 


The LimeSurvey ComfortUpdate feature is safe to use even with active surveys. It does not delete or destroy any existing data. However you should keep in mind that this is a beta feature and ensure you have backed up your database and files manually before proceeding.


*Go to the Global Settings Icon, select the first tab, and click the button for “Updates”
*The ComfortUpdate screen will display an update link if a new version of LimeSurvey is available. If not click “Check now” to see if a new update is available.
*If an update is found, LimeSurvey will display a link to allow you to update. Click on this to begin updating.
*If you have never used ComfortUpdate before or the ComfortUpdate upgrade key is not valid, you will be asked to enter an upgrade key. During the trial period use the default key for free updates.
*LimeSurvey will now verify your installation directory to check the appropriate permissions are set to allow an update. A list of proposed changes will be displayed.
*If there are any problems, you must correct them at this point, and then proceed to the next step.
*The ComfortUpdate will now make a backup of your database (if you use MySQL) and save your old installation files in the /tmp directory. If you use a different database, you should backup your database manually before proceeding.
ComfortUpdate will now update your installation to the latest version, including updating the database for any new changes.

=Disabling ComfortUpdate= 
If you want to disable ComfortUpdate to not get the ''New release available'' popup messages after each new release you can add the following option to your "config.php" file which can be found at ''/limesurvey/application/config'' (Always create a backup first!):
'updatable' => false


This is documented in more detail at "[http://www.limesurvey-consulting.com/how-to-disable-the-comfortupdate-updating-feature-at-limesurvey/ How to disable the Limesurvey ComfortUpdate updating feature]".

=Known problems= 

==Blank page on step 3== 


If you get a blank page on step 3 it usually means that the memory limit of your PHP configuration is set too low. During that step LimeSurvey tries to create a database backup and a file backup (of the files that will be replaced).

==Using a proxy server to connect to update.limesurvey.com== 


If you are behind a proxy, you may have to adjust some settings to be able to use comfort update. In LimeSurvey 2.05 later than build 140404, you can set the details of your proxy server in the configuration file (see [https://manual.limesurvey.org/Optional_settings#General_settings General settings]).


For earlier versions, you have to edit the http.php file in your LimeSurvey installation. Have a look at the variables in the first lines of this file in a text editor and add values if needed.


Example: Connect to a proxy server 111.111.111.111 port 1234 without authentication edit the following lines to look like
var $proxy_host_name="111.111.111.111";
var $proxy_host_port=1234;


Depending on your version, you will find the file in the /admin/classes/ folder or in /application/libraries/admin/http/. There are pre-coded variables within the file so only details of your proxy are needed. If your installation is running unusually slow, wrong proxy settings may be the cause.
</translate>

Upgrading from a previous version

2017-04-01T03:59:33Z

Regexaurus:

<languages /> <translate>

<div style="float:right;"><div class="simplebox">Additional pages:{toc}</div></div>__TOC__

=Before you start...= 


<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 adminstration tool like [http://www.phpmyadmin.net phpMyAdmin] etc. and a file manager! If you don't know how to do this you should not proceed but ask someone who knows or use the [[ComfortUpdate]] instead.

=The quick way (for minor version changes)= 


You can use these instructions if you are doing a minor upgrade (for example from 2.00 to 2.01)
*Backup your files and database (did we already mention that?)
*Delete all the old files/directory except for
**/application/config/config.php
**/upload directory (NOTE: If you have any customized templates sitting under /upload/templates, make sure you refresh those with any changes from the new version. The easiest way to check for such changes is to file-compare your old template with the new version of the default template, and if you see any differences other than your customizations, a refresh is needed.)
*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.
*'''After the upgrade: Clear your browser cache and cookies!'''

=The thorough way (for big version jumps)= 


Unfortunately there are a couple of things to consider, so please scan the following instructions closely.

==Upgrading from version 2.0x to 2.50 or later== 
*Please note that the template structure has changed. Your old templates will not be working anymore as the template system is now using responsive templates.

==Upgrading from version 1.50 or later to any later 2.xx version== 
#[http://www.limesurvey.org#download Download] the latest version of LimeSurvey.
# Prepare and backup the old installation
## 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 phpMyAdmin or similar to export all tables; or use the according '''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
## Delete all old files in the existing installation directory
## Upload and unpack the new code version into the same installation directory
## If your previous version was 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
## Double check the '''permissions''' set on the directories (write access to '''/tmp''', '''/upload''' and and their subdirectories is required) as described in [[Installation#Set_Directory_permissions|Installation]]
## 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.
# Check if any special manual checks apply as listed below
# '''Now clear your browser cache and cookies!'''
# You are done (:biggrin:).


{{Alert|title=Attention|text=If you upgrade from e.g. 1.92, it might be necessary to ''first'' upgrade to latest 1.92, then to 2.00, then to 2.06, and then finally to the latest version (e.g. 2.55.x).}}


<div class="simplebox">'''Special checks after an upgrade''':
*'''from any earlier version to 2.xx''':
**The '''templates''' have been changed in a lot of places. 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). The upgrade process tries to replace the template.js inclusion by the placeholder {TEMPLATEJS}. If you have javascript issue with your custom template, verify if your template have the placeholder {TEMPLATEJS} in startpage.pstpl.
**Proper question codes are mandatory now. After upgrade 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 who to give this right to 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 permission for 'surveys' were activated. So if a user has any permission besides the 'create' they will be able to apply this additional permission on other surveys then their own. So please check the global permission of admin users that should only be able to see their own surveys and make sure they only have the 'create' permission assigned for 'surveys'.
</div>

==Upgrading from version 1.50 or later to any later 1.xx version== 
#[http://www.limesurvey.org/download Download] the desired version of LimeSurvey.
# Prepare and backup the old installation
## 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. e.g. tar cvzf foo.tgz cps100 will tar and zip the whole of the cps100 directory
### Using 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
## Delete all old files in the existing installation directory
## Upload and unpack the new code version into the same installation directory
## Edit or replace the '''config.php''' file:
### If your previous version was < 1.70: Edit the new '''config.php''' to reflect changed settings in the backup '''config.php''' file. '''Do not just overwrite the new '''config.php''' with your old one!'''
### If your previous version was >= 1.70: Simply replace the new '''config.php''' with your backup '''config.php''' (as the file format has not changed).
## If your previous version was 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
## Double check the '''permissions''' set on the directories (write access to '''/tmp''', '''/upload''' and and their subdirectories is required) as described in [[Installation#Set Directory permissions|Installation]]
# Finishing the installation
## Once you open the URL to your LimeSurvey administration the database tables will be updated after confirmation
## Remove or rename the '''/admin/install''' directory as/if instructed by the installation script
## Check if any special, manual checks apply as listed below
# You are done (:biggrin:). If you notice any problems after the upgrade: Clear your browser cache and cookies!


<div class="simplebox">'''Special checks after an upgrade''':
*'''from any earlier version to 1.92''': The '''templates''' have been changed in a lot of places. 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 who to give this right to in the older versions. As this is not perfect, it should be carefully checked.</div>

==Upgrading from a version earlier than v1.50 (v1.0 through v1.44)== 


Since the data structure and a lot of other things were changed, '''upgrading from any version previous to v1.50 is NOT possible'''. If you have old survey structure files with a *.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. See the also then page [[Transferring an installation]] for more details.

=Upgrade 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?== 


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 best way to port LimeSurvey *.sql survey structure files to the latest version?== 


Install version 1.50, import the file and export the survey structure to the newer .csv format. The latest version still can read the .csv survey structure format.
</translate>

Optional settings

2017-04-01T03:29:30Z

Regexaurus:

<languages /> <translate>


__TOC__

=How to modify optional settings= 


The optional settings can only be found in the file /application/config/config-defaults.php of a standard installation - some of them are only used for first installation, some of them overriden in [[Global settings]].


{{Alert|If you want to change these settings please do not change it in config-defaults.php but copy the particular setting/line over to /application/config/config.php in <nowiki>'config'=>array()</nowiki> and change it there.}}
All settings in config.php overwrite the default values from config-defaults.php and some of these settings get overridden in the Global settings dialog{{NewIn|1.87}} . This way it is much easier to upgrade your installation at a later time!


To update/add the LimeSurvey settings in /application/config/config.php you have to update the config array:
<syntaxhighlight lang="php" enclose="pre">
'config'=>array(
'debug'=>0,
'debugsql'=>0,
'LimeSurveySetting'=>'New value',
)
</syntaxhighlight>

=Yii settings= 
LimeSurvey uses the Yii framework and Yii has its own configuration parameters in the application/config/config.php file. You can access some specific configuration settings of LimeSurvey also via the Yii configuration.


The Yii-specific settings are set in the components array:
<syntaxhighlight lang="php" enclose="pre">
'components' => array(
'db' => array(
....
),
'Specific settings'=>array(
....
),
),
</syntaxhighlight>

==Database settings== 
The database settings are written by the installer to the config.php file when you install LimeSurvey for the first time. If needed you can update this part of the config. Please remember that you do this at your own risk.
See also the [[http://www.yiiframework.com/doc/blog/1.1/en/prototype.database#establishing-database-connection Yii documentation]], and please remember that LimeSurvey supports only the database types mysql,pgsql,dblib,mssql, and sqlsrv.

==Session settings== 
You can set some session parameters in config.php, the first example is the session in the database. You can uncomment/add the part needed in config.php. See [[http://www.yiiframework.com/doc/api/1.1/CHttpSession Yii Documentation]] for other settings.


If you use SSL ('https') for your LimeSurvey installation adding the following lines to your config.php will increase session security:
<syntaxhighlight lang="php" enclose="pre"> // Set the cookie via SSL
'session' => array (
'cookieParams' => array(
'secure' => true, // use SSL for cookies
'httponly' => true // Cookies may not be used by other protocols - experimental
),
),
</syntaxhighlight>


If you want to fix the domain for a cookie use this in config.php:
<syntaxhighlight lang="php" enclose="pre"> // Set the domain for cookie
'session' => array (
'cookieParams' => array(
'domain' => '.example.org',
),
),
</syntaxhighlight>

==Request settings== 
The request settings are important, but the default settings are already optimized for LimeSurvey usage. See [http://www.yiiframework.com/doc/api/1.1/CHttpRequest Yii Documentation] for more information.


Some example you can modify in your LimeSurvey configuration:<sup>At your own risk</sup> :
<syntaxhighlight lang="php" enclose="pre"> // Disable CSRF protection
'request' => array(
'enableCsrfValidation'=>false,
),
</syntaxhighlight>
<syntaxhighlight lang="php" enclose="pre"> // Enforce a certain base URL
'request' => array(
'hostInfo' => 'http://www.example.org/'
),
</syntaxhighlight>
<syntaxhighlight lang="php" enclose="pre"> // Set the cookie domain name for CSRF protection
'request' => array(
'csrfCookie' => array( 'domain' => '.example.com' )
),
</syntaxhighlight>


If you need updating only the url for token email : you can set your [[Optional_settings#Advanced_Path_Settings|publicurl]] in your config.php file.

==URL settings== 
To have the same behaviour like the old 'Fancy URL' feature , you can update the urlManager
<syntaxhighlight lang="php" enclose="pre"> // Use short URL
'urlManager' => array(
'urlFormat' => 'path',
'showScriptName' => false,
),
</syntaxhighlight>
Adding .html after the survey id
<syntaxhighlight lang="php" enclose="pre"> // Use short URL
'urlManager' => array(
'urlFormat' => 'path',
'rules' => array (
'<sid:\d+>' => array('survey/index','urlSuffix'=>'.html','matchValue'=>true),
),
'showScriptName' => false,
),
</syntaxhighlight>
Find more information in the [http://www.yiiframework.com/doc/guide/1.1/en/topics.url Yii documentation].

=General settings= 


*'''sitename''': Give your survey site a name. This name will appear in the survey list overview and in the administration header. This setting is used only as default value and overridden in the [[Global settings]] dialog {{NewIn|1.87}}.
*'''siteadminemail:''' This is the default email address of the site administrator and used for system messages and contact options. This setting is used only as default value and overridden by the [[Global settings]] dialog {{NewIn|1.87}}.
*'''siteadminbounce:''' This is the email address where bounced emails will be sent to. This setting is used only as default value and overridden by the [[Global settings]] dialog {{NewIn|1.87}}.
*'''siteadminname:''' The real name of the site administrator. This setting is used only as default value and overridden in the [[Global settings]] dialog) {{NewIn|1.87}}.
*'''proxy_host_name:''' This is the host name of your proxy server (if you are behind a proxy and want to update LimeSurvey using ComfortUpdate) {{NewIn|2.05}}.
*'''proxy_host_port:''' This is the port of your proxy server (if you are behind a proxy and want to update LimeSurvey using ComfortUpdate) {{NewIn|2.05}}.

= Security= 


* '''maxLoginAttempt''': If the user enters password incorrectly this is the number of attempts before the users is locked out by IP address.
* '''timeOutTime''': If the user enters password incorrectly for <maxLoginAttempt> set the lock out time (in seconds).
* '''surveyPreview_require_Auth''': true by default. If you set this to false any person can test your survey using the survey URL - without logging in to the administration and without having to activate the survey first. This setting is a default value and can be overridden in the [[Global settings]] dialog {{NewIn|1.87}}.
* '''usercontrolSameGroupPolicy''' : Set to true by default. By default non-admin users defined in the LimeSurvey management interface will only be able to see users they create or users that belongs to at least one same group. This setting is a default value and can be overridden in the [[Global settings]] dialog.
*'''filterxsshtml:''' This setting enables filtering of suspicious html tags in survey, group, questions and answer texts in the administration interface. Only leave this to 'false' if you absolutely trust the users you created for the administration of LimeSurvey and if you want to allow these users to be able to use Javascript, Flash Movies, etc. <span class="warning">Super admin never have their HTML filtered</span>. This setting is a default value and can be overridden in the [[Global settings]] dialog {{NewIn|1.87}}.
*'''demoModeOnly:''' If this option is set to true, then LimeSurvey will go into demo mode. The demo mode changes the following things:
** Disables changing of the admin user's details and password
** Disables uploading files on the template editor
** Disables sending email invitations and reminders
** Disables doing a database dump
** Disables the ability to modify the following global settings: Site name, Default language, Default Htmleditor Mode, XSS filter

= Resources= 
*'''sessionlifetime:''' Defines the time in seconds after which a survey session expires. It applies only if you are using database sessions. This setting is overridden in the [[Global settings]] dialog) {{NewIn|1.87}}.
*'''memorylimit:''' This sets how much memory LimeSurvey can access. '128M' is the minimum (M=Megabyte) recommended. If you receive time out errors or have problems generating statistics or exporting files raise this limit to '256M' or higher. If your webserver has set a higher limit then this setting will be ignored.


<div class="warningbox">Please mind that such local settings by an application can always be overruled by global server settings.</div>


To increase the memory limit to 128M you could also try adding:
*memory_limit = 128M to your server's main php.ini file (recommended, if you have access)
*memory_limit = 128M to a php.ini file in the LimeSurvey root
*php_value memory_limit 128M in a .htaccess file in the LimeSurvey root

=Appearance= 
*'''lwcdropdowns:'''{{ObsoleteIn|2.0}} This can be set to either "L" or "R". Setting it to "R" will result in 'List with Comment' questions being displayed as radio buttons, whereas "L" will result in 'List with Comment' questions being displayed in a 'dropdown' list box .
*'''dropdownthreshold:''''{{ObsoleteIn|2.50}} When you have selected "R" for $dropdowns, this allows you to set a maximum number of options that will display as radio buttons, before converting back to a dropdown list. If you have a question that has a large number of options, displaying them all as radio buttons can look unweildy, and be counter-intuitive to users. Setting this to a maximum of, say 25 (which is the default) means that large lists are easier for the survey participant to use.
*'''repeatheadings:''' With the Array type question, often you'll have a lot of subquestions, which - when displayed on screen - take up more than one page. This setting lets you decide how many subquestions should be displayed before repeating the header information for the question. A good setting for this is around 15. If you don't want the headings to repeat at all, set this to 0. This setting is overridden in the [[Global settings]] dialog) {{NewIn|2.05}}.
*'''minrepeatheadings:''' The minimum number of remaining subquestions that are required before repeating the headings in Array questions.
*'''defaulttemplate:''' This setting specifys the default theme used for the 'public list' of surveys. This setting is overridden in the [[Global settings]] dialog) {{NewIn|1.87}}.
*'''defaulthtmleditormode:''' Sets the default mode for integrated HTML editor. This setting is overridden in the [[Global settings]] dialog) {{NewIn|1.87}}. Valid settings are:
** ''inline'': Inline replacement of fields by an HTML editor. Slow but convenient and user friendly
** ''popup'': Adds an icon that runs the HTML editor in a popup if needed. Faster, but HTML code is displayed in the form.
** ''none'': No HTML editor
*'''column_style:''' Defines how columns are rendered for survey answers when using [[QS:Display_columns|display_columns]]. Valid settings are:
** 'css' using one of the various CSS only methods for creating columns (see template style sheet for details).
** 'ul' using multiple floated unordered lists. (default)
** 'table' using conventional tables based layout.
** NULL disable the use of columns

=Language & time= 
*'''defaultlang:''' This should be set to the default language to be used in your administration scripts, and also the default setting for language in the public survey list. This setting is overridden in the [[Global settings]] dialog) {{NewIn|1.87}}.
*'''timeadjust:''' If your web server is in a different time zone to the location where your surveys will be based, put the difference between your server and your home time zone here. For example, I live in Australia but use a US web server. The web server is 14 hours behind my local time zone. So my setting here is "14". In other words, it adds 14 hours to the web servers time. This setting is particularly important when surveys timestamp the responses. This setting is overridden in the [[Global settings]] dialog) {{NewIn|1.87}}.

=Survey behavior= 
*'''deletenonvalues:''' Use this feature with caution. By default (a value of 1), irrelevant questions are NULLed in the database. This ensures that the data in your database is internally consistent. However, there are rare cases where you might want to hold onto irrelevant values, in which case you can set the value to 0. Say you ask the person his gender, and he accidentally says 'female' and then answers some female-specific questions (questions that are conditioned on being female, so are only relevant for women). Then, he realizes his mistake, backs up, sets the gender to 'male', and continues with the survey. Now, the female-specific questions are irrelevant. If $deletenonvalues==1, those irrelevant values will be cleared (NULLed) in the database. If $deletenonvalues==0, his erroneous answers will not be deleted, so they will still be present in the database when you analyze it.
*'''shownoanswer:''' When a question of a radio button/select type that contains editable answers (ie: List, Array questions) is not mandatory and shownoanswer is set to 1, an additional 'No answer' entry is shown - so that participants may choose to not answer the question. Some people prefer this not to be available. This setting is overridden in the [[Global settings]] dialog) {{NewIn|1.87}}. Valid values are:
**0 = no ,
**1 = yes ,
**2 = survey admin can choose.
*'''printanswershonorsconditions:''' This setting determines if the printanswers feature will display entries from questions that were hidden by conditions-branching (Default: 1 = hide answers from questions hidden by conditions).
*'''hide_groupdescr_allinone:'''{{NewIn|1.85}} This setting is relevant for all-in-one surveys using conditions . When this is set to true the group name and description is hidden if all questions in the group are hidden. (Default: true - hide group name and description when all questions in the group are hidden by conditions)
*'''showpopups:''' Show popup messages if mandatory or conditional questions have not been answered correctly. 1=Show popup message (default), 0=Show message on page instead, -1=Do not show the message at all (in this case, users will still see the question-specific tips indicating which questions must be answered).

=Development and debugging= 
*'''debug:''' With this setting you set the PHP error reporting to E_ALL. That means every little notice, warning or error with the script is shown. This setting should be only switched to 1 if you are trying to debug the application for any reason, if you are a developer switch it to 2. Don't switch it to 1 or 2 in production since it might cause path disclosure. (Default: 0)
*'''debugsql:''' Activate this setting if you want to display all SQL queries executed for the script on the bottom of each page. Very useful for optimizing the number of queries


If you experience an error in the application, we strongly recommend to acivate the debug setting so you usually get some more detailed error that you can submit with the bug report:


<syntaxhighlight lang="php" enclose="pre">
'config'=>array(
'debug'=>2,
'debugsql'=>0,
)
</syntaxhighlight>

= Email Settings= 


Note: All these settings in this section are overridden in the [[Global settings]] dialog{{NewIn|1.87}}.
*'''emailmethod:''' This determines how E-mail messages are being sent. The following options are available:
**'''mail:''' use internal PHP mailer
**'''sendmail:''' use sendmail mailer
**'''smtp:'''use SMTP relaying. Use this setting when you are running LimeSurvey on a host that is not your mail server.
*'''emailsmtphost:''' If you use 'smtp' as $emailmethod then you have to put your SMTP-server here. If you are using Google mail you might have to add the port number like $emailsmtphost = 'smtp.gmail.com:465';
*'''emailsmtpuser:''' If your SMTP-server needs authentication then set this to your user name, otherwise it must be blank.
*'''emailsmtppassword:''' If your SMTP-server needs authentication then set this to your password, otherwise it must be blank.
*'''emailsmtpssl:''' Set this to 'ssl' or 'tls' to use SSL/TLS for SMTP connection
*'''maxemails:''' When sending invitations or reminders to survey participants, this setting is used to determine how many emails can be sent in one bunch. Different web servers have different email capacities, and if your script takes too long to send a bunch of emails, the script could time out and cause errors. Most web servers can send 100 emails at a time within the default 30 second time limit for a PHP script. If you get script timeout errors when sending large numbers of emails, reduce the number in this setting. Clicking the 'send email invitation' button on the token control toolbar, (not the button on the right of each token), sends the maxemails number of invitations, then displays a list of the addresses sent to and a warning that "There are more emails pending than could be sent in one batch. Continue sending emails by clicking below. There are ### emails still to be sent." and provides a "continue button" to proceed with the next batch. I.e., the user determines when to send the next batch after each batch gets emailed. It is not necessary to wait with this screen active. The admin could log off and come back at a later time to send the next batch of invites.

= Statistics and Response Browsing= 
*'''usejpgraph:''' {{ObsoleteIn|1.8}} The [http://www.aditus.nu/jpgraph/ JPGraph-library] lets you display the results of your survey in the statistics part of LimeSurvey in bar- and pie charts. If you have a correctly configured jpgraph class set up on your server, you can turn this feature on or off (1=on, 0=off). Please have a look, every version of PHP needs another version of JPGraph! This feature is currently in development, so expect a few weird outcomes.
*'''jpgraphdir:''' {{ObsoleteIn|1.8}} The physical disk location of the jpgraph class scripts. This setting is only required if $usejpgraph is equal to 1.
*'''jpgraphfont:''' {{ObsoleteIn|1.8}} The font to use with graphs. A failsafe setting would be "FF_FONT1"
*'''embedded:'''{{ObsoleteIn|2.0}} If you want to integrate LimeSurvey into another page then you can turn off sending HTML headers by using this setting and point instead to the header method of a custom function. This is a dirty hack but should work for a quick integration.
*'''filterout_incomplete_answers:''' Control the default behaviour of filtering incomplete answers when browsing or analyzing responses. For a discussion on incomplete Responses see [[Browsing survey results]]. Since these records can corrupt the statistics, an option is given to switch this filter on or off in several GUI forms. This parameter config.php is just the default state for the incomplete answer filter. The following options are available:
**''show'': Show both complete and incomplete answers
**''filter'': Show only complete answers
**''incomplete'': Show only incomplete answers
*'''strip_query_from_referer_url''': This setting determine if the referrer URL saves parameter or not. Default value is "false" (in this case referrer URL saves all parameter). Alternatively this value can be set to "true" and the parameter part of the referrer URL will be removed.
*'''showaggregateddata:''' {{NewIn|1.8}} When activated there are additional values like arithmetic mean and standard deviation at statistics. Furthermore data is aggregated to get a faster overview e.g. results of scale 1+2 and 4+5 are added to have a general ranking like "good" (1/2), "average" (3) and "bad" (4/5). This only affects question types "A" (5 point array) and "5" (5 point choice).
* '''PDF Export Settings:''' {{NewIn|1.85}} This feature activates PDF export for printable survey and Print Answers. The PDF export is totally experimental. The output is mostly ugly. At this point no support can be given - if you want to help to fix it please get in touch with us.
**usepdfexport: Set 0 to disable; 1 to enable
**pdfdefaultfont: Default font for the pdf Export
**alternatepdffontfile: an array with key for language and specific font for this language can be replaced or just updated .
**pdffontsize: Fontsize for normal text; Surveytitle is +4; grouptitle is +2
**notsupportlanguages = array('zh-Hant-TW','zh-Hant-HK','zh-Hans','ja','th');
**pdforientation: Set L for Landscape or P for portrait format
*'"Graph setting"'
** chartfontfile : Font file to be used : must be in the server font directory or ./fonts directory
** alternatechartfontfile : an array with key for language and specific font for this language can be replaced or just updated .
*'''showsgqacode:''' {{NewIn|1.91}} This setting is used at the printable survey feature and defaults to ''false''. If you set ''showsgqacode = true;'' the IDs for each question - and answer if applicable - will be shown; these IDs match the column heading at the Lime_survey_12345 table which holds the answer data for a certain survey. These Ids can be used for a code book for manual database queries.

= [[LDAP settings]]= 


As this is an extensive topic we have moved [[LDAP settings]] to [[LDAP settings|another page.]]

= Authentication= 


Starting with LimeSurvey 2.05 authentication will be handled by plugins. Because of this the information below might be outdated. See [[Plugins]] for most up to date information.

== Delegate Authentication to the Webserver== 


System Administrators may want to have their '''survey administrators''' authenticated against a central authentication system (Active Directory, openLdap, Radius, ...) rather than using the internal LimeSurvey database. An easy way to do this is to setup your Webserver software to use this external authentication system, and then ask LimeSurvey to trust the user identity reported by the webserver. In order to enable this feature you have to:
* set '''auth_webserver''' to true in config.php
* enable authentication at the webserver side


Please note that:
* LimeSurvey will then bypass its own authentication process (by using the login name reported by the webserver without asking for a password)
* this can only replace the LimeSurvey GUI authentication system, '''not the survey invitation system''' (participant interface)

== Authentication Delegation with no automatic user import== 


Please note however than <u>by default Authentication Delegation doesn't bypass the LimeSurvey authorization system</u>: this means that, even if you don't have to manage passwords in LimeSurvey, you still need to define the users in the LimeSurvey database and assign them the correct set of rights in order to let them access survey resources.


A user is then granted access to LimeSurvey if and only if:
* he has been authenticated to the webserver
* his login name is defined as a user in the LimeSurvey user database (the user is then granted the privileges of the user defined in the LimeSurvey user database).

== Authentication Delegation with automatic user import== 


When managing huge user database, it is sometimes easier to auto-import user in the LimeSurvey database.
*'''auth_webserver_autocreate_user''': if set to true LimeSurvey will try to autoimport users authenticated by the webserver but not already in its users' DB
*'''auth_webserver_autocreate_profile''': an array describing the default profile that will be assigned to the user (including fake First and Last name, email, privileges)


If you want to customize the user profile so that it matches the logged-in user, you'll have to develop a simple function called '''hook_get_autouserprofile''': with this function you can retrieve from a central User account database (for instance an LDAP directory), the true First&Last; names and email of a particular user. You can even customize his privileges on the system based on his groups on the external DB.


The '''hook_get_auth_webserver_profile''' function takes the user login name as the only argument and can return:
* False or an empty array: in this case the user is denied access to LimeSurvey
* an array containing all common userprofile entries as described in the '''$WebserverAuth_autouserprofile'''

</translate><syntaxhighlight lang="php" enclose="div">function hook_get_auth_webserver_profile($user_name)
{
// Retrieve user's data from your database backend (for instance LDAP) here
... get $user_name_from_backend
... get $user_email_from_backend
... get $user_lang_from_backend
... from groups defined in your backend set $user_admin_status_frombackend_0_or_1
return Array(
'full_name' => "$user_name_from_backend",
'email' => "$user_email_from_backend",
'lang' => '$user_lang_from_backend',
'htmleditormode' => 'inline',
'templatelist' => 'default,basic,MyOrgTemplate',
'create_survey' => 1,
'create_user' => 0,
'delete_user' => 0,
'superadmin' => $user_admin_status_frombackend_0_or_1,
'configurator' =>0,
'manage_template' => 0,
'manage_label' => 0);
}

// If user should be denied access, return an empty array

// return Array();</syntaxhighlight><translate>

== User name mapping== 


In case some users have an external user name that is different from their LimeSurvey user name, you may find useful to use a user name mapping. This is done in LimeSurvey by using the '''auth_webserver_user_map''' parameter. For instance imagine you don't have an 'admin' username defined in your external authentication database. Then in order to login to LimeSurvey as admin, you'll have to map your external username let's call it 'myname' to the admin login name in LimeSurvey. The corresponding setup is :

</translate>
<syntaxhighlight lang="php" enclose="div">$config['auth_webserver_user_map'] = Array ('myname' => 'admin');</syntaxhighlight><translate>


After a successful authentication with the 'myname' login and password to the webserver, you'll be directly authorized to use LimeSurvey as the 'admin' user.


This obviously has serious security implications, so use it with care, and please protect your config.php from write access by the web server.

== Use one time passwords== 


{{NewIn|1.81}} A user can open the LimeSurvey login at /limesurvey/admin and pass username and a one time password which was previously written into the users table (column one_time_pw) by an external application.


This setting has to be turned on ('''use_one_time_passwords''' => true) to enable the usage of one time passwords (default = false). More information can be found at [[Manage users#Use one-time passwords|"Manage Users"]].

= Advanced Path Settings= 


*'''homeurl:''' This should be set to the URL location of your administration scripts. These are the scripts in the /limesurvey/admin folder. This should be set to the WEB URL location - for example "http://www.example.com/limesurvey/html/admin". Don't add a trailing slash to this entry. The default setting in config.php attempts to detect the name of your server automatically using a php variable setting - {$_SERVER<nowiki>[</nowiki>'SERVER_NAME']}. In most cases you can leave this and just modify the remainder of this string to match the directory name you have put the LimeSurvey scripts in.
*'''publicurl:''' This should be set to the URL location of your 'public scripts'. The public scripts are those located in the "limesurvey" folder (or whatever name you gave to the directory that all the other scripts and directories are kept in). '''This settings is available in config.php and is used when sending token email.'''
*'''tempurl:''' This should be set to the URL location of your "/limesurvey/tmp" directory - or a directory which you would like LimeSurvey to use to store temporary files, including uploads. This directory must be set to read & write for your webserver (e.g. chmod 755).
*'''imagefiles:''' By default you should leave this pointing to the URL location of /limesurvey/admin/images - where the images are installed initially. You may, however, prefer to move these images to another location and if so point this to the URL directory where they are stored.
*'''homedir:''' This should be set to the physical disk location of your administration scripts - for example "/home/usr/htdocs/limesurvey/admin". Don't add a trailing slash to this entry. The default setting in config.php attempts to detect the default root path of all your documents using the php variable setting - {$_SERVER<nowiki>[</nowiki>'DOCUMENT_ROOT']}. In most cases you can leave this and just modify the remainder of this string to match the directory name you have put the LimeSurvey scripts in.
*'''publicdir:''' This should be set to the physical disk location of your 'public scripts'.
*'''tempdir:''' This should be set to the physical disk location of your /limesurvey/tmp directory so that the script can read and write files.
*'''sCKEditorURL:''' url of the fckeditor script
*'''fckeditexpandtoolbar:''' defines if the FCKeditor toolbar should be opened by default
*'''pdfexportdir:''' Directory with the tcpdf.php extensiontcpdf.php
*'''pdffonts:''' Directory for the TCPDF fonts
</translate>

Optional settings

2017-04-01T03:12:33Z

Regexaurus:

<languages /> <translate>


__TOC__

=How to modify optional settings= 


The optional settings can only be found in the file /application/config/config-defaults.php of a standard installation - some of them are only used for first installation, some of them overriden in [[Global settings]].


{{Alert|If you want to change these settings please do not change it in config-defaults.php but copy the particular setting/line over to /application/config/config.php in <nowiki>'config'=>array()</nowiki> and change it there.}}
All settings in config.php overwrite the default values from config-defaults.php and some of these settings get overridden in the Global settings dialog{{NewIn|1.87}} . This way it is much easier to upgrade your installation at a later time!


To update/add the LimeSurvey settings in /application/config/config.php you have to update the config array:
<syntaxhighlight lang="php" enclose="pre">
'config'=>array(
'debug'=>0,
'debugsql'=>0,
'LimeSurveySetting'=>'New value',
)
</syntaxhighlight>

=Yii settings= 
LimeSurvey uses the Yii framework and Yii has its own configuration parameters in the application/config/config.php file. You can access some specific configuration settings of LimeSurvey also via the Yii configuration.


The Yii-specific settings are set in the components array:
<syntaxhighlight lang="php" enclose="pre">
'components' => array(
'db' => array(
....
),
'Specific settings'=>array(
....
),
),
</syntaxhighlight>

==Database settings== 
The database settings are written by the installer to the config.php file when you install LimeSurvey for the first time. If needed you can update this part of the config. Please remember that you do this at your own risk.
See also the [[http://www.yiiframework.com/doc/blog/1.1/en/prototype.database#establishing-database-connection Yii documentation]], and please remember that LimeSurvey supports only the database types mysql,pgsql,dblib,mssql, and sqlsrv.

==Session settings== 
You can set some session parameters in config.php, the first example is the session in the database. You can uncomment/add the part needed in config.php. See [[http://www.yiiframework.com/doc/api/1.1/CHttpSession Yii Documentation]] for other settings.


If you use SSL ('https') for your LimeSurvey installation adding the following lines to your config.php will increase session security:
<syntaxhighlight lang="php" enclose="pre"> // Set the cookie via SSL
'session' => array (
'cookieParams' => array(
'secure' => true, // use SSL for cookies
'httponly' => true // Cookies may not be used by other protocols - experimental
),
),
</syntaxhighlight>


If you want to fix the domain for a cookie use this in config.php:
<syntaxhighlight lang="php" enclose="pre"> // Set the domain for cookie
'session' => array (
'cookieParams' => array(
'domain' => '.example.org',
),
),
</syntaxhighlight>

==Request settings== 
The request settings are important, but the default settings are already optimized for LimeSurvey usage. See [http://www.yiiframework.com/doc/api/1.1/CHttpRequest Yii Documentation] for more information.


Some example you can modify in your LimeSurvey configuration:<sup>At your own risk</sup> :
<syntaxhighlight lang="php" enclose="pre"> // Disable CSRF protection
'request' => array(
'enableCsrfValidation'=>false,
),
</syntaxhighlight>
<syntaxhighlight lang="php" enclose="pre"> // Enforce a certain base URL
'request' => array(
'hostInfo' => 'http://www.example.org/'
),
</syntaxhighlight>
<syntaxhighlight lang="php" enclose="pre"> // Set the cookie domain name for CSRF protection
'request' => array(
'csrfCookie' => array( 'domain' => '.example.com' )
),
</syntaxhighlight>


If you need updating only the url for token email : you can set your [[Optional_settings#Advanced_Path_Settings|publicurl]] in your config.php file.

==URL settings== 
To have the same behaviour like the old 'Fancy URL' feature , you can update the urlManager
<syntaxhighlight lang="php" enclose="pre"> // Use short URL
'urlManager' => array(
'urlFormat' => 'path',
'showScriptName' => false,
),
</syntaxhighlight>
Adding .html after the survey id
<syntaxhighlight lang="php" enclose="pre"> // Use short URL
'urlManager' => array(
'urlFormat' => 'path',
'rules' => array (
'<sid:\d+>' => array('survey/index','urlSuffix'=>'.html','matchValue'=>true),
),
'showScriptName' => false,
),
</syntaxhighlight>
Find more information in the [http://www.yiiframework.com/doc/guide/1.1/en/topics.url Yii documentation].

=General settings= 


*'''sitename''': Give your survey site a name. This name will appear in the survey list overview and in the administration header. This setting is used only as default value and overridden in the [[Global settings]] dialog {{NewIn|1.87}}.
*'''siteadminemail:''' This is the default email address of the site administrator and used for system messages and contact options. This setting is used only as default value and overridden by the [[Global settings]] dialog {{NewIn|1.87}}.
*'''siteadminbounce:''' This is the email address where bounced emails will be sent to. This setting is used only as default value and overridden by the [[Global settings]] dialog {{NewIn|1.87}}.
*'''siteadminname:''' The real name of the site administrator. This setting is used only as default value and overridden in the [[Global settings]] dialog) {{NewIn|1.87}}.
*'''proxy_host_name:''' This is the host name of your proxy server (if you are behind a proxy and want to update LimeSurvey using ComfortUpdate) {{NewIn|2.05}}.
*'''proxy_host_port:''' This is the port of your proxy server (if you are behind a proxy and want to update LimeSurvey using ComfortUpdate) {{NewIn|2.05}}.

= Security= 


* '''maxLoginAttempt''': If the user enters password incorrectly this is the number of attempts before the users is locked out by IP address.
* '''timeOutTime''': If the user enters password incorrectly for <maxLoginAttempt> set the lock out time (in seconds).
* '''surveyPreview_require_Auth''': true by default. If you set this to false any person can test your survey using the survey URL - without logging in to the administration and without having to activate the survey first. This setting is a default value and can be overridden in the [[Global settings]] dialog {{NewIn|1.87}}.
* '''usercontrolSameGroupPolicy''' : Set to true by default. By default non-admin users defined in the LimeSurvey management interface will only be able to see users they create or users that belongs to at least one same group. This setting is a default value and can be overridden in the [[Global settings]] dialog.
*'''filterxsshtml:''' This setting enables filtering of suspicious html tags in survey, group, questions and answer texts in the administration interface. Only leave this to 'false' if you absolutely trust the users you created for the administration of LimeSurvey and if you want to allow these users to be able to use Javascript, Flash Movies, etc. <span class="warning">Super admin never have their HTML filtered</span>. This setting is a default value and can be overridden in the [[Global settings]] dialog {{NewIn|1.87}}.
*'''demoModeOnly:''' If this option is set to true, then LimeSurvey will go into demo mode. The demo mode changes the following things:
** Disables changing of the admin user's details and password
** Disables uploading files on the template editor
** Disables sending email invitations and reminders
** Disables doing a database dump
** Disables the ability to modify the following global settings: Site name, Default language, Default Htmleditor Mode, XSS filter

= Resources= 
*'''sessionlifetime:''' Defines the time in seconds after which a survey session expires. It applies only if you are using database sessions. This setting is overridden in the [[Global settings]] dialog) {{NewIn|1.87}}.
*'''memorylimit:''' This sets how much memory LimeSurvey can access. '128M' is the minimum (M=Megabyte) recommended. If you receive time out errors or have problems generating statistics or exporting files raise this limit to '256M' or higher. If your webserver has set a higher limit then this setting will be ignored.


<div class="warningbox">Please mind that such local settings by an application can always be overruled by global server settings.</div>


To increase the memory limit to 128M you could also try adding:
*memory_limit = 128M to your server's main php.ini file (recommended, if you have access)
*memory_limit = 128M to a php.ini file in the LimeSurvey root
*php_value memory_limit 128M in a .htaccess file in the LimeSurvey root

=Appearance= 
*'''lwcdropdowns:'''{{ObsoleteIn|2.0}} This can be set to either "L" or "R". Setting it to "R" will result in 'List with Comment' questions being displayed as radio buttons, whereas "L" will result in 'List with Comment' questions being displayed in a 'dropdown' list box .
*'''dropdownthreshold:''''{{ObsoleteIn|2.50}} When you have selected "R" for $dropdowns, this allows you to set a maximum number of options that will display as radio buttons, before converting back to a dropdown list. If you have a question that has a large number of options, displaying them all as radio buttons can look unweildy, and be counter-intuitive to users. Setting this to a maximum of, say 25 (which is the default) means that large lists are easier for the survey participant to use.
*'''repeatheadings:''' With the Array type question, often you'll have a lot of subquestions, which - when displayed on screen - take up more than one page. This setting lets you decide how many subquestions should be displayed before repeating the header information for the question. A good setting for this is around 15. If you don't want the headings to repeat at all, set this to 0. This setting is overridden in the [[Global settings]] dialog) {{NewIn|2.05}}.
*'''minrepeatheadings:''' The minimum number of remaining subquestions that are required before repeating the headings in Array questions.
*'''defaulttemplate:''' This setting specifys the default theme used for the 'public list' of surveys. This setting is overridden in the [[Global settings]] dialog) {{NewIn|1.87}}.
*'''defaulthtmleditormode:''' Sets the default mode for integrated HTML editor. This setting is overridden in the [[Global settings]] dialog) {{NewIn|1.87}}. Valid settings are:
** ''inline'': Inline replacement of fields by an HTML editor. Slow but convenient and user friendly
** ''popup'': Adds an icon that runs the HTML editor in a popup if needed. Faster, but HTML code is displayed in the form.
** ''none'': No HTML editor
*'''column_style:''' Defines how columns are rendered for survey answers when using [[QS:Display_columns|display_columns]]. Valid settings are:
** 'css' using one of the various CSS only methods for creating columns (see template style sheet for details).
** 'ul' using multiple floated unordered lists. (default)
** 'table' using conventional tables based layout.
** NULL disable the use of columns

=Language & time= 
*'''defaultlang:''' This should be set to the default language to be used in your administration scripts, and also the default setting for language in the public survey list. This setting is overridden in the [[Global settings]] dialog) {{NewIn|1.87}}.
*'''timeadjust:''' If your web server is in a different time zone to the location where your surveys will be based, put the difference between your server and your home time zone here. For example, I live in Australia but use a US web server. The web server is 14 hours behind my local time zone. So my setting here is "14". In other words, it adds 14 hours to the web servers time. This setting is particularly important when surveys timestamp the responses. This setting is overridden in the [[Global settings]] dialog) {{NewIn|1.87}}.

=Survey behavior= 
*'''deletenonvalues:''' Use this feature with caution. By default (a value of 1), irrelevant questions are NULLed in the database. This ensures that the data in your database is internally consistent. However, there are rare cases where you might want to hold onto irrelevant values, in which case you can set the value to 0. Say you ask the person his gender, and he accidentally says 'female' and then answers some female-specific questions (questions that are conditioned on being female, so are only relevant for women). Then, he realizes his mistake, backs up, sets the gender to 'male', and continues with the survey. Now, the female-specific questions are irrelevant. If $deletenonvalues==1, those irrelevant values will be cleared (NULLed) in the database. If $deletenonvalues==0, his erroneous answers will not be deleted, so they will still be present in the database when you analyze it.
*'''shownoanswer:''' When a question of a radio button/select type that contains editable answers (ie: List, Array questions) is not mandatory and shownoanswer is set to 1, an additional 'No answer' entry is shown - so that participants may choose to not answer the question. Some people prefer this not to be available. This setting is overridden in the [[Global settings]] dialog) {{NewIn|1.87}}. Valid values are:
**0 = no ,
**1 = yes ,
**2 = survey admin can choose.
*'''printanswershonorsconditions:''' This setting determines if the printanswers feature will display entries from questions that were hidden by conditions-branching (Default: 1 = hide answers from questions hidden by conditions).
*'''hide_groupdescr_allinone:'''{{NewIn|1.85}} This setting is relevant for all-in-one surveys using conditions . When this is set to true the group name and description is hidden if all questions in the group are hidden. (Default: true - hide group name and description when all questions in the group are hidden by conditions)
*'''showpopups:''' Show popup messages if mandatory or conditional questions have not been answered correctly. 1=Show popup message (default), 0=Show message on page instead, -1=Do not show the message at all (in this case, users will still see the question-specific tips indicating which questions must be answered).

=Development and debugging= 
*'''debug:''' With this setting you set the PHP error reporting to E_ALL. That means every little notice, warning or error with the script is shown. This setting should be only switched to 1 if you are trying to debug the application for any reason, if you are a developer switch it to 2. Don't switch it to 1 or 2 in production since it might cause path disclosure. (Default: 0)
*'''debugsql:''' Activate this setting if you want to display all SQL queries executed for the script on the bottom of each page. Very useful for optimizing the number of queries


If you experience an error in the application, we strongly recommend to acivate the debug setting so you usually get some more detailed error that you can submit with the bug report:


<syntaxhighlight lang="php" enclose="pre">
'config'=>array(
'debug'=>2,
'debugsql'=>0,
)
</syntaxhighlight>

= Email Settings= 


Note: All these settings in this section are overridden in the [[Global settings]] dialog{{NewIn|1.87}}.
*'''emailmethod:''' This determines how E-mail messages are being sent. The following options are available:
**'''mail:''' use internal PHP mailer
**'''sendmail:''' use sendmail mailer
**'''smtp:'''use SMTP relaying. Use this setting when you are running LimeSurvey on a host that is not your mail server.
*'''emailsmtphost:''' If you use 'smtp' as $emailmethod then you have to put your SMTP-server here. If you are using Google mail you might have to add the port number like $emailsmtphost = 'smtp.gmail.com:465';
*'''emailsmtpuser:''' If your SMTP-server needs authentication then set this to your user name, otherwise it must be blank.
*'''emailsmtppassword:''' If your SMTP-server needs authentication then set this to your password, otherwise it must be blank.
*'''emailsmtpssl:''' Set this to 'ssl' or 'tls' to use SSL/TLS for SMTP connection
*'''maxemails:''' When sending invitations or reminders to survey participants, this setting is used to determine how many emails can be sent in one bunch. Different web servers have different email capacities, and if your script takes too long to send a bunch of emails, the script could time out and cause errors. Most web servers can send 100 emails at a time within the default 30 second time limit for a PHP script. If you get script timeout errors when sending large numbers of emails, reduce the number in this setting. Clicking the 'send email invitation' button on the token control toolbar, (not the button on the right of each token), sends the maxemails number of invitations, then displays a list of the addresses sent to and a warning that "There are more emails pending than could be sent in one batch. Continue sending emails by clicking below. There are ### emails still to be sent." and provides a "continue button" to proceed with the next batch. I.e., the user determines when to send the next batch after each batch gets emailed. It is not necessary to wait with this screen active. The admin could log off and come back at a later time to send the next batch of invites.

= Statistics and Response Browsing= 
*'''usejpgraph:''' {{ObsoleteIn|1.8}} The [http://www.aditus.nu/jpgraph/ JPGraph-library] lets you display the results of your survey in the statistics part of LimeSurvey in bar- and pie charts. If you have a correctly configured jpgraph class set up on your server, you can turn this feature on or off (1=on, 0=off). Please have a look, every version of PHP needs another version of JPGraph! This feature is currently in development, so expect a few weird outcomes.
*'''jpgraphdir:''' {{ObsoleteIn|1.8}} The physical disk location of the jpgraph class scripts. This setting is only required if $usejpgraph is equal to 1.
*'''jpgraphfont:''' {{ObsoleteIn|1.8}} The font to use with graphs. A failsafe setting would be "FF_FONT1"
*'''embedded:'''{{ObsoleteIn|2.0}} If you want to integrate LimeSurvey into another page then you can turn off sending HTML headers by using this setting and point instead to the header method of a custom function. This is a dirty hack but should work for a quick integration.
*'''filterout_incomplete_answers:''' Control the default behaviour of filtering incomplete answers when browsing or analyzing responses. For a discussion on incomplete Responses see [[Browsing survey results]]. Since these records can corrupt the statistics, an option is given to switch this filter on or off in several GUI forms. This parameter config.php is just the default state for the incomplete answer filter. The following options are available:
**''show'': Show both complete and incomplete answers
**''filter'': Show only complete answers
**''incomplete'': Show only incomplete answers
*'''strip_query_from_referer_url''': This setting determine if the referrer URL saves parameter or not. Default value is "false" (in this case referrer URL saves all parameter). Alternatively this value can be set to "true" and the parameter part of the referrer URL will be removed.
*'''showaggregateddata:''' {{NewIn|1.8}} When activated there are additional values like arithmetic mean and standard deviation at statistics. Furthermore data is aggregated to get a faster overview e.g. results of scale 1+2 and 4+5 are added to have a general ranking like "good" (1/2), "average" (3) and "bad" (4/5). This only affects question types "A" (5 point array) and "5" (5 point choice).
* '''PDF Export Settings:''' {{NewIn|1.85}} This feature activates PDF export for printable survey and Print Answers. The PDF export is totally experimental. The output is mostly ugly. At this point no support can be given - if you want to help to fix it please get in touch with us.
**usepdfexport: Set 0 to disable; 1 to enable
**pdfdefaultfont: Default font for the pdf Export
**alternatepdffontfile: an array with key for language and specific font for this language can be replaced or just updated .
**pdffontsize: Fontsize for normal text; Surveytitle is +4; grouptitle is +2
**notsupportlanguages = array('zh-Hant-TW','zh-Hant-HK','zh-Hans','ja','th');
**pdforientation: Set L for Landscape or P for portrait format
*'"Graph setting"'
** chartfontfile : Font file to be used : must be in the server font directory or ./fonts directory
** alternatechartfontfile : an array with key for language and specific font for this language can be replaced or just updated .
*'''showsgqacode:''' {{NewIn|1.91}} This setting is used at the printable survey feature and defaults to ''false''. If you set ''showsgqacode = true;'' the IDs for each question - and answer if applicable - will be shown; these IDs match the column heading at the Lime_survey_12345 table which holds the answer data for a certain survey. These Ids can be used for a code book for manual database queries.

= [[LDAP settings]]= 


As this is an extensive topic we have moved [[LDAP settings]] to [[LDAP settings|another page.]]

= Authentication= 


Starting with LimeSurvey 2.05 authentication will be handled by plugins. Because of this the information below might be outdated. See [[Plugins]] for most up to date information.

== Delegate Authentication to the Webserver== 


System Administrators may want to have their '''survey administrators''' authenticated against a central authentication system (Active Directory, openLdap, Radius, ...) rather than using the internal LimeSurvey database. An easy way to do this is to setup your Webserver software to use this external authentication system, and then ask LimeSurvey to trust the user identity reported by the webserver. In order to enable this feature you have to:
* set '''auth_webserver''' to true in config.php
* enable authentication at the webserver side


Please note that:
* LimeSurvey will then bypass its own authentication process (by using the login name reported by the webserver without asking for a password)
* this can only replace the LimeSurvey GUI authentication system, '''not the survey invitation system''' (participant interface)

== Authentication Delegation with no automatic user import== 


Please note however than <u>by default Authentication Delegation doesn't bypass the LimeSurvey authorization system</u>: this means that, even if you don't have to manage passwords in LimeSurvey, you still need to define the users in the LimeSurvey database and assign them the correct set of rights in order to let them access survey resources.


A user is then granted access to LimeSurvey if and only if:
* he has been authenticated to the webserver
* his login name is defined as a user in the LimeSurvey user database (the user is then granted the privileges of the user defined in the LimeSurvey user database).

== Authentication Delegation with automatic user import== 


When managing huge user database, it is sometimes easier to auto-import user in the LimeSurvey database.
*'''auth_webserver_autocreate_user''': if set to true LimeSurvey will try to autoimport users authenticated by the webserver but not already in its users' DB
*'''auth_webserver_autocreate_profile''': an array describing the default profile that will be assigned to the user (including fake First and Last name, email, privileges)


If you want to customize the user profile so that it matches the logged-in user, you'll have to develop a simple function called '''hook_get_autouserprofile''': with this function you can retrieve from a central User account database (for instance an LDAP directory), the true First&Last; names and email of a particular user. You can even customize his privileges on the system based on his groups on the external DB.


The '''hook_get_auth_webserver_profile''' function takes the user login name as the only argument and can return:
* False or an empty array: in this case the user is denied access to LimeSurvey
* an array containing all common userprofile entries as described in the '''$WebserverAuth_autouserprofile'''

</translate><syntaxhighlight lang="php" enclose="div">function hook_get_auth_webserver_profile($user_name)
{
// Retrieve user's data from your database backend (for instance LDAP) here
... get $user_name_from_backend
... get $user_email_from_backend
... get $user_lang_from_backend
... from groups defined in your backend set $user_admin_status_frombackend_0_or_1
return Array(
'full_name' => "$user_name_from_backend",
'email' => "$user_email_from_backend",
'lang' => '$user_lang_from_backend',
'htmleditormode' => 'inline',
'templatelist' => 'default,basic,MyOrgTemplate',
'create_survey' => 1,
'create_user' => 0,
'delete_user' => 0,
'superadmin' => $user_admin_status_frombackend_0_or_1,
'configurator' =>0,
'manage_template' => 0,
'manage_label' => 0);
}

// If user should be denied access, return an empty array

// return Array();</syntaxhighlight><translate>

== User name mapping== 


In case some users have an external user name that is different from their LimeSurvey user name, you may find useful to use a user name mapping. This is done in LimeSurvey by using the '''auth_webserver_user_map''' parameter. For instance imagine you don't have an 'admin' username defined in your external authentication database. Then in order to login to LimeSurvey as admin, you'll have to map your external username let's call it 'myname' to the admin login name ine LimeSurvey. The corresponding setup is :

</translate>
<syntaxhighlight lang="php" enclose="div">$config['auth_webserver_user_map'] = Array ('myname' => 'admin');</syntaxhighlight><translate>


After a successful authentication with the 'myname' login and password to the webserver, you'll be directly authorized to use LimeSurvey as the 'admin' user.


This obviously has serious security implications, so use it with care, and please protect your config.php from write access by the web server.

== Use one time passwords== 


{{NewIn|1.81}} A user can open the LimeSurvey login at /limesurvey/admin and pass username and a one time password which was previously written into the users table (column one_time_pw) by an external application.


This setting has to be turned on ('''use_one_time_passwords''' => true) to enable the usage of one time passwords (default = false). More information can be found at [[Manage users#Use one-time passwords|"Manage Users"]].

= Advanced Path Settings= 


*'''homeurl:''' This should be set to the URL location of your administration scripts. These are the scripts in the /limesurvey/admin folder. This should be set to the WEB URL location - for example "http://www.example.com/limesurvey/html/admin". Don't add a trailing slash to this entry. The default setting in config.php attempts to detect the name of your server automatically using a php variable setting - {$_SERVER<nowiki>[</nowiki>'SERVER_NAME']}. In most cases you can leave this and just modify the remainder of this string to match the directory name you have put the LimeSurvey scripts in.
*'''publicurl:''' This should be set to the URL location of your 'public scripts'. The public scripts are those located in the "limesurvey" folder (or whatever name you gave to the directory that all the other scripts and directories are kept in). '''This settings is available in config.php and is used when sending token email.'''
*'''tempurl:''' This should be set to the URL location of your "/limesurvey/tmp" directory - or a directory which you would like LimeSurvey to use to store temporary files, including uploads. This directory must be set to read & write for your webserver (e.g. chmod 755).
*'''imagefiles:''' By default you should leave this pointing to the URL location of /limesurvey/admin/images - where the images are installed initially. You may, however, prefer to move these images to another location and if so point this to the URL directory where they are stored.
*'''homedir:''' This should be set to the physical disk location of your administration scripts - for example "/home/usr/htdocs/limesurvey/admin". Don't add a trailing slash to this entry. The default setting in config.php attempts to detect the default root path of all your documents using the php variable setting - {$_SERVER<nowiki>[</nowiki>'DOCUMENT_ROOT']}. In most cases you can leave this and just modify the remainder of this string to match the directory name you have put the LimeSurvey scripts in.
*'''publicdir:''' This should be set to the physical disk location of your 'public scripts'.
*'''tempdir:''' This should be set to the physical disk location of your /limesurvey/tmp directory so that the script can read and write files.
*'''sCKEditorURL:''' url of the fckeditor script
*'''fckeditexpandtoolbar:''' defines if the FCKeditor toolbar should be opened by default
*'''pdfexportdir:''' Directory with the tcpdf.php extensiontcpdf.php
*'''pdffonts:''' Directory for the TCPDF fonts
</translate>

Optional settings

2017-03-31T22:56:00Z

Regexaurus:

<languages /> <translate>


__TOC__

=How to modify optional settings= 


The optional settings can only be found in the file /application/config/config-defaults.php of a standard installation - some of them are only used for first installation, some of them overriden in [[Global settings]].


{{Alert|If you want to change these settings please do not change it in config-defaults.php but copy the particular setting/line over to /application/config/config.php in <nowiki>'config'=>array()</nowiki> and change it there.}}
All settings in config.php overwrite the default values from config-defaults.php and some of these settings get overridden in the Global settings dialog{{NewIn|1.87}} . This way it is much easier to upgrade your installation at a later time!


To update/add the LimeSurvey settings in /application/config/config.php you have to update the config array:
<syntaxhighlight lang="php" enclose="pre">
'config'=>array(
'debug'=>0,
'debugsql'=>0,
'LimeSurveySetting'=>'New value',
)
</syntaxhighlight>

=Yii settings= 
LimeSurvey uses the Yii framework and Yii has its own configuration parameters in the application/config/config.php file. You can access some specific configuration settings of LimeSurvey also via the Yii configuration.


The Yii-specific settings are set in the components array:
<syntaxhighlight lang="php" enclose="pre">
'components' => array(
'db' => array(
....
),
'Specific settings'=>array(
....
),
),
</syntaxhighlight>

==Database settings== 
The database settings are written by the installer to the config.php file when you install LimeSurvey for the first time. If needed you can update this part of the config. Please remember that you do this at your own risk.
See also the [[http://www.yiiframework.com/doc/blog/1.1/en/prototype.database#establishing-database-connection Yii documentation]], and please remember that LimeSurvey supports only the database types mysql,pgsql,dblib,mssql, and sqlsrv.

==Session settings== 
You can set some session parameters in config.php, the first example is the session in the database. You can uncomment/add the part needed in config.php. See [[http://www.yiiframework.com/doc/api/1.1/CHttpSession Yii Documentation]] for other settings.


If you use SSL ('https') for your LimeSurvey installation adding the following lines to your config.php will increase session security:
<syntaxhighlight lang="php" enclose="pre"> // Set the cookie via SSL
'session' => array (
'cookieParams' => array(
'secure' => true, // use SSL for cookies
'httponly' => true // Cookies may not be used by other protocols - experimental
),
),
</syntaxhighlight>


If you want to fix the domain for a cookie use this in config.php:
<syntaxhighlight lang="php" enclose="pre"> // Set the domain for cookie
'session' => array (
'cookieParams' => array(
'domain' => '.example.org',
),
),
</syntaxhighlight>

==Request settings== 
The request settings are important, but the default settings are already optimized for LimeSurvey usage. See [http://www.yiiframework.com/doc/api/1.1/CHttpRequest Yii Documentation] for more information.


Some example you can modify in your LimeSurvey configuration:<sup>At your own risk</sup> :
<syntaxhighlight lang="php" enclose="pre"> // Disable CSRF protection
'request' => array(
'enableCsrfValidation'=>false,
),
</syntaxhighlight>
<syntaxhighlight lang="php" enclose="pre"> // Enforce a certain base URL
'request' => array(
'hostInfo' => 'http://www.example.org/'
),
</syntaxhighlight>
<syntaxhighlight lang="php" enclose="pre"> // Set the cookie domain name for CSRF protection
'request' => array(
'csrfCookie' => array( 'domain' => '.example.com' )
),
</syntaxhighlight>


If you need updating only the url for token email : you can set your [[Optional_settings#Advanced_Path_Settings|publicurl]] in your config.php file.

==URL settings== 
To have the same behaviour like the old 'Fancy URL' feature , you can update the urlManager
<syntaxhighlight lang="php" enclose="pre"> // Use short URL
'urlManager' => array(
'urlFormat' => 'path',
'showScriptName' => false,
),
</syntaxhighlight>
Adding .html after the survey id
<syntaxhighlight lang="php" enclose="pre"> // Use short URL
'urlManager' => array(
'urlFormat' => 'path',
'rules' => array (
'<sid:\d+>' => array('survey/index','urlSuffix'=>'.html','matchValue'=>true),
),
'showScriptName' => false,
),
</syntaxhighlight>
Find more information in the [http://www.yiiframework.com/doc/guide/1.1/en/topics.url Yii documentation].

=General settings= 


*'''sitename''': Give your survey site a name. This name will appear in the survey list overview and in the administration header. This setting is used only as default value and overridden in the [[Global settings]] dialog {{NewIn|1.87}}.
*'''siteadminemail:''' This is the default email address of the site administrator and used for system messages and contact options. This setting is used only as default value and overridden by the [[Global settings]] dialog {{NewIn|1.87}}.
*'''siteadminbounce:''' This is the email address where bounced emails will be sent to. This setting is used only as default value and overridden by the [[Global settings]] dialog {{NewIn|1.87}}.
*'''siteadminname:''' The real name of the site administrator. This setting is used only as default value and overridden in the [[Global settings]] dialog) {{NewIn|1.87}}.
*'''proxy_host_name:''' This is the host name of your proxy server (if you are behind a proxy and want to update LimeSurvey using ComfortUpdate) {{NewIn|2.05}}.
*'''proxy_host_port:''' This is the port of your proxy server (if you are behind a proxy and want to update LimeSurvey using ComfortUpdate) {{NewIn|2.05}}.

= Security= 


* '''maxLoginAttempt''': If the user enters password incorrectly this is the number of attempts before the users is locked out by IP address.
* '''timeOutTime''': If the user enters password incorrectly for <maxLoginAttempt> set the lock out time (in seconds).
* '''surveyPreview_require_Auth''': true by default. If you set this to false any person can test your survey using the survey URL - without logging in to the administration and without having to activate the survey first. This setting is a default value and can be overridden in the [[Global settings]] dialog {{NewIn|1.87}}.
* '''usercontrolSameGroupPolicy''' : Set to true by default. By default non-admin users defined in the LimeSurvey management interface will only be able to see users they create or users that belongs to at least one same group. This setting is a default value and can be overridden in the [[Global settings]] dialog.
*'''filterxsshtml:''' This setting enables filtering of suspicious html tags in survey, group, questions and answer texts in the administration interface. Only leave this to 'false' if you absolutely trust the users you created for the administration of LimeSurvey and if you want to allow these users to be able to use Javascript, Flash Movies, etc. <span class="warning">Super admin never have their HTML filtered</span>. This setting is a default value and can be overridden in the [[Global settings]] dialog {{NewIn|1.87}}.
*'''demoModeOnly:''' If this option is set to true, then LimeSurvey will go into demo mode. The demo mode changes the following things:
** Disables changing of the admin user's details and password
** Disables uploading files on the template editor
** Disables sending email invitations and reminders
** Disables doing a database dump
** Disables the ability to modify the following global settings: Site name, Default language, Default Htmleditor Mode, XSS filter

= Resources= 
*'''sessionlifetime:''' Defines the time in seconds after which a survey session expires. It applies only if you are using database sessions. This setting is overridden in the [[Global settings]] dialog) {{NewIn|1.87}}.
*'''memorylimit:''' This sets how much memory LimeSurvey can access. '128M' is the minimum (M=Megabyte) recommended. If you receive time out errors or have problems generating statistics or exporting files raise this limit to '256M' or higher. If your webserver has set a higher limit then this setting will be ignored.


<div class="warningbox">Please mind that such local settings by an application can always be overruled by global server settings.</div>


To increase the memory limit to 128M you could also try adding:
*memory_limit = 128M to your server's main php.ini file (recommended, if you have access)
*memory_limit = 128M to a php.ini file in the LimeSurvey root
*php_value memory_limit 128M in a .htaccess file in the LimeSurvey root

=Appearance= 
*'''lwcdropdowns:'''{{ObsoleteIn|2.0}} This can be set to either "L" or "R". Setting it to "R" will result in 'List with Comment' questions being displayed as radio buttons, whereas "L" will result in 'List with Comment' questions being displayed in a 'dropdown' list box .
*'''dropdownthreshold:''''{{ObsoleteIn|2.50}} When you have selected "R" for $dropdowns, this allows you to set a maximum number of options that will display as radio buttons, before converting back to a dropdown list. If you have a question that has a large number of options, displaying them all as radio buttons can look unweildy, and be counter-intuitive to users. Setting this to a maximum of, say 25 (which is the default) means that large lists are easier for the survey participant to use.
*'''repeatheadings:''' With the Array type question, often you'll have a lot of subquestions, which - when displayed on screen - take up more than one page. This setting lets you decide how many subquestions should be displayed before repeating the header information for the question. A good setting for this is around 15. If you don't want the headings to repeat at all, set this to 0. This setting is overridden in the [[Global settings]] dialog) {{NewIn|2.05}}.
*'''minrepeatheadings:''' The minimum number of remaining subquestions that are required before repeating the headings in Array questions.
*'''defaulttemplate:''' This setting specifys the default theme used for the 'public list' of surveys. This setting is overridden in the [[Global settings]] dialog) {{NewIn|1.87}}.
*'''defaulthtmleditormode:''' Sets the default mode for integrated HTML editor. This setting is overridden in the [[Global settings]] dialog) {{NewIn|1.87}}. Valid settings are:
** ''inline'': Inline replacement of fields by an HTML editor. Slow but convenient and user friendly
** ''popup'': Adds an icon that runs the HTML editor in a popup if needed. Faster, but HTML code is displayed in the form.
** ''none'': No HTML editor
*'''column_style:''' Defines how columns are rendered for survey answers when using [[QS:Display_columns|display_columns]]. Valid settings are:
** 'css' using one of the various CSS only methods for creating columns (see template style sheet for details).
** 'ul' using multiple floated unordered lists. (default)
** 'table' using conventional tables based layout.
** NULL disable the use of columns

=Language & time= 
*'''defaultlang:''' This should be set to the default language to be used in your administration scripts, and also the default setting for language in the public survey list. This setting is overridden in the [[Global settings]] dialog) {{NewIn|1.87}}.
*'''timeadjust:''' If your web server is in a different time zone to the location where your surveys will be based, put the difference between your server and your home time zone here. For example, I live in Australia but use a US web server. The web server is 14 hours behind my local time zone. So my setting here is "14". In other words, it adds 14 hours to the web servers time. This setting is particularly important when surveys timestamp the responses. This setting is overridden in the [[Global settings]] dialog) {{NewIn|1.87}}.

=Survey behavior= 
*'''deletenonvalues:''' Use this feature with caution. By default (a value of 1), irrelevant questions are NULLed in the database. This ensures that the data in your database is internally consistent. However, there are rare cases where you might want to hold onto irrelevant values, in which case you can set the value to 0. Say you ask the person his gender, and he accidentally says 'female' and then answers some female-specific questions (questions that are conditioned on being female, so are only relevant for women). Then, he realizes his mistake, backs up, sets the gender to 'male', and continues with the survey. Now, the female-specific questions are irrelevant. If $deletenonvalues==1, those irrelevant values will be cleared (NULLed) in the database. If $deletenonvalues==0, his erroneous answers will not be deleted, so they will still be present in the database when you analyze it.
*'''shownoanswer:''' When a question of a radio button/select type that contains editable answers (ie: List, Array questions) is not mandatory and shownoanswer is set to 1, an additional 'No answer' entry is shown - so that participants may choose to not answer the question. Some people prefer this not to be available. This setting is overridden in the [[Global settings]] dialog) {{NewIn|1.87}}. Valid values are:
**0 = no ,
**1 = yes ,
**2 = survey admin can choose.
*'''printanswershonorsconditions:''' This setting determines if the printanswers feature will display entries from questions that were hidden by conditions-branching (Default: 1 = hide answers from questions hidden by conditions).
*'''hide_groupdescr_allinone:'''{{NewIn|1.85}} This setting is relevant for all-in-one surveys using conditions . When this is set to true the group name and description is hidden if all questions in the group are hidden. (Default: true - hide group name and description when all questions in the group are hidden by conditions)
*'''showpopups:''' Show popup messages if mandatory or conditional questions have not been answered correctly. 1=Show popup message (default), 0=Show message on page instead, -1=Do not show the message at all (in this case, users will still see the question-specific tips indicating which questions must be answered).

=Development and debugging= 
*'''debug:''' With this setting you set the PHP error reporting to E_ALL. That means every little notice, warning or error with the script is shown. This setting should be only switched to 1 if you are trying to debug the application for any reason, if you are a developer switch it to 2. Don't switch it to 1 or 2 in production since it might cause path disclosure. (Default: 0)
*'''debugsql:''' Activate this setting if you want to display all SQL queries executed for the script on the bottom of each page. Very useful for optimizing the number of queries


If you experience an error in the application, we strongly recommend to acivate the debug setting so you usually get some more detailed error that you can submit with the bug report:


<syntaxhighlight lang="php" enclose="pre">
'config'=>array(
'debug'=>2,
'debugsql'=>0,
)
</syntaxhighlight>

= Email Settings= 


Note: All these settings in this section are overridden in the [[Global settings]] dialog{{NewIn|1.87}}.
*'''emailmethod:''' This determines how E-mail messages are being sent. The following options are available:
**'''mail:''' use internal PHP mailer
**'''sendmail:''' use sendmail mailer
**'''smtp:'''use SMTP relaying. Use this setting when you are running LimeSurvey on a host that is not your mail server.
*'''emailsmtphost:''' If you use 'smtp' as $emailmethod then you have to put your SMTP-server here. If you are using Google mail you might have to add the port number like $emailsmtphost = 'smtp.gmail.com:465';
*'''emailsmtpuser:''' If your SMTP-server needs authentication then set this to your user name, otherwise it must be blank.
*'''emailsmtppassword:''' If your SMTP-server needs authentication then set this to your password, otherwise it must be blank.
*'''emailsmtpssl:''' Set this to 'ssl' or 'tls' to use SSL/TLS for SMTP connection
*'''maxemails:''' When sending invitations or reminders to survey participants, this setting is used to determine how many emails can be sent in one bunch. Different web servers have different email capacities, and if your script takes too long to send a bunch of emails, the script could time out and cause errors. Most web servers can send 100 emails at a time within the default 30 second time limit for a PHP script. If you get script timeout errors when sending large numbers of emails, reduce the number in this setting. Clicking the 'send email invitation' button on the token control toolbar, (not the button on the right of each token), sends the maxemails number of invitations, then displays a list of the addresses sent to and a warning that "There are more emails pending than could be sent in one batch. Continue sending emails by clicking below. There are ### emails still to be sent." and provides a "continue button" to proceed with the next batch. I.e., the user determines when to send the next batch after each batch gets emailed. It is not necessary to wait with this screen active. The admin could log off and come back at a later time to send the next batch of invites.

= Statistics and Response Browsing= 
*'''usejpgraph:''' {{ObsoleteIn|1.8}} The [http://www.aditus.nu/jpgraph/ JPGraph-library] lets you display the results of your survey in the statistics part of LimeSurvey in bar- and pie charts. If you have a correctly configured jpgraph class set up on your server, you can turn this feature on or off (1=on, 0=off). Please have a look, every version of PHP needs another version of JPGraph! This feature is currently in development, so expect a few weird outcomes.
*'''jpgraphdir:''' {{ObsoleteIn|1.8}} The physical disk location of the jpgraph class scripts. This setting is only required if $usejpgraph is equal to 1.
*'''jpgraphfont:''' {{ObsoleteIn|1.8}} The font to use with graphs. A failsafe setting would be "FF_FONT1"
*'''embedded:'''{{ObsoleteIn|2.0}} If you want to integrate LimeSurvey into another page then you can turn off sending HTML headers by using this setting and point instead to the header method of a custom function. This is a dirty hack but should work for a quick integration.
*'''filterout_incomplete_answers:''' Control the default behaviour of filtering incomplete answers when browsing or analyzing responses. For a discussion on incomplete Responses see [[Browsing survey results]]. Since these records can corrupt the statistics, an option is given to switch this filter on or off in several GUI forms. This parameter config.php is just the default state for the incomplete answer filter. The following options are available:
**''show'': Show both complete and incomplete answers
**''filter'': Show only complete answers
**''incomplete'': Show only incomplete answers
*'''strip_query_from_referer_url''': This setting determine if the referrer URL saves parameter or not. Default value is "false" (in this case referrer URL saves all parameter). Alternatively this value can be set to "true" and the parameter part of the referrer URL will be removed.
*'''showaggregateddata:''' {{NewIn|1.8}} When activated there are additional values like arithmetic mean and standard deviation at statistics. Furthermore data is aggregated to get a faster overview e.g. results of scale 1+2 and 4+5 are added to have a general ranking like "good" (1/2), "average" (3) and "bad" (4/5). This only affects question types "A" (5 point array) and "5" (5 point choice).
* '''PDF Export Settings:''' {{NewIn|1.85}} This feature activates PDF export for printable survey and Print Answers. The PDF export is totally experimental. The output is mostly ugly. At this point no support can be given - if you want to help to fix it please get in touch with us.
**usepdfexport: Set 0 to disable; 1 to enable
**pdfdefaultfont: Default font for the pdf Export
**alternatepdffontfile: an array with key for language and specific font for this language can be replaced or just updated .
**pdffontsize: Fontsize for normal text; Surveytitle is +4; grouptitle is +2
**notsupportlanguages = array('zh-Hant-TW','zh-Hant-HK','zh-Hans','ja','th');
**pdforientation: Set L for Landscape or P for portrait format
*'"Graph setting"'
** chartfontfile : Font file to be used : must be in the server font directory or in ./fot directory
** alternatechartfontfile : an array with key for language and specific font for this language can be replaced or just updated .
*'''showsgqacode:''' {{NewIn|1.91}} This setting is used at the printable survey feature and defaults to ''false''. If you set ''showsgqacode = true;'' the IDs for each question - and answer if applicable - will be shown; these IDs match the column heading at the Lime_survey_12345 table which holds the answer data for a certain survey. These Ids can be used for a code book for manual database queries.

= [[LDAP settings]]= 


As this is an extensive topic we have moved [[LDAP settings]] to [[LDAP settings|another page.]]

= Authentication= 


Starting with LimeSurvey 2.05 authentication will be handled by plugins. Because of this the information below might be outdated. See [[Plugins]] for most up to date information.

== Delegate Authentication to the Webserver== 


System Administrators may want to have their '''survey administrators''' authenticated against a central authentication system (Active Directory, openLdap, Radius, ...) rather than using the internal LimeSurvey database. An easy way to do this is to setup your Webserver software to use this external authentication system, and then ask LimeSurvey to trust the user identity reported by the webserver. In order to enable this feature you have to:
* set '''auth_webserver''' to true in config.php
* enable authentication at the webserver side


Please note that:
* LimeSurvey will then bypass its own authentication process (by using the login name reported by the webserver without asking for a password)
* this can only replace the LimeSurvey GUI authentication system, '''not the survey invitation system''' (participant interface)

== Authentication Delegation with no automatic user import== 


Please note however than <u>by default Authentication Delegation doesn't bypass the LimeSurvey authorization system</u>: this means that, even if you don't have to manage passwords in LimeSurvey, you still need to define the users in the LimeSurvey database and assign them the correct set of rights in order to let them access survey resources.


A user is then granted access to LimeSurvey if and only if:
* he has been authenticated to the webserver
* his login name is defined as a user in the LimeSurvey user database (the user is then granted the privileges of the user defined in the LimeSurvey user database).

== Authentication Delegation with automatic user import== 


When managing huge user database, it is sometimes easier to auto-import user in the LimeSurvey database.
*'''auth_webserver_autocreate_user''': if set to true LimeSurvey will try to autoimport users authenticated by the webserver but not already in its users' DB
*'''auth_webserver_autocreate_profile''': an array describing the default profile that will be assigned to the user (including fake First and Last name, email, privileges)


If you want to customize the user profile so that it matches the logged-in user, you'll have to develop a simple function called '''hook_get_autouserprofile''': with this function you can retrieve from a central User account database (for instance an LDAP directory), the true First&Last; names and email of a particular user. You can even customize his privileges on the system based on his groups on the external DB.


The '''hook_get_auth_webserver_profile''' function takes the user login name as the only argument and can return:
* False or an empty array: in this case the user is denied access to LimeSurvey
* an array containing all common userprofile entries as described in the '''$WebserverAuth_autouserprofile'''

</translate><syntaxhighlight lang="php" enclose="div">function hook_get_auth_webserver_profile($user_name)
{
// Retrieve user's data from your database backend (for instance LDAP) here
... get $user_name_from_backend
... get $user_email_from_backend
... get $user_lang_from_backend
... from groups defined in your backend set $user_admin_status_frombackend_0_or_1
return Array(
'full_name' => "$user_name_from_backend",
'email' => "$user_email_from_backend",
'lang' => '$user_lang_from_backend',
'htmleditormode' => 'inline',
'templatelist' => 'default,basic,MyOrgTemplate',
'create_survey' => 1,
'create_user' => 0,
'delete_user' => 0,
'superadmin' => $user_admin_status_frombackend_0_or_1,
'configurator' =>0,
'manage_template' => 0,
'manage_label' => 0);
}

// If user should be denied access, return an empty array

// return Array();</syntaxhighlight><translate>

== User name mapping== 


In case some users have an external user name that is different from their LimeSurvey user name, you may find useful to use a user name mapping. This is done in LimeSurvey by using the '''auth_webserver_user_map''' parameter. For instance imagine you don't have an 'admin' username defined in your external authentication database. Then in order to login to LimeSurvey as admin, you'll have to map your external username let's call it 'myname' to the admin login name ine LimeSurvey. The corresponding setup is :

</translate>
<syntaxhighlight lang="php" enclose="div">$config['auth_webserver_user_map'] = Array ('myname' => 'admin');</syntaxhighlight><translate>


After a successful authentication with the 'myname' login and password to the webserver, you'll be directly authorized to use LimeSurvey as the 'admin' user.


This obviously has serious security implications, so use it with care, and please protect your config.php from write access by the web server.

== Use one time passwords== 


{{NewIn|1.81}} A user can open the LimeSurvey login at /limesurvey/admin and pass username and a one time password which was previously written into the users table (column one_time_pw) by an external application.


This setting has to be turned on ('''use_one_time_passwords''' => true) to enable the usage of one time passwords (default = false). More information can be found at [[Manage users#Use one-time passwords|"Manage Users"]].

= Advanced Path Settings= 


*'''homeurl:''' This should be set to the URL location of your administration scripts. These are the scripts in the /limesurvey/admin folder. This should be set to the WEB URL location - for example "http://www.example.com/limesurvey/html/admin". Don't add a trailing slash to this entry. The default setting in config.php attempts to detect the name of your server automatically using a php variable setting - {$_SERVER<nowiki>[</nowiki>'SERVER_NAME']}. In most cases you can leave this and just modify the remainder of this string to match the directory name you have put the LimeSurvey scripts in.
*'''publicurl:''' This should be set to the URL location of your 'public scripts'. The public scripts are those located in the "limesurvey" folder (or whatever name you gave to the directory that all the other scripts and directories are kept in). '''This settings is available in config.php and is used when sending token email.'''
*'''tempurl:''' This should be set to the URL location of your "/limesurvey/tmp" directory - or a directory which you would like LimeSurvey to use to store temporary files, including uploads. This directory must be set to read & write for your webserver (e.g. chmod 755).
*'''imagefiles:''' By default you should leave this pointing to the URL location of /limesurvey/admin/images - where the images are installed initially. You may, however, prefer to move these images to another location and if so point this to the URL directory where they are stored.
*'''homedir:''' This should be set to the physical disk location of your administration scripts - for example "/home/usr/htdocs/limesurvey/admin". Don't add a trailing slash to this entry. The default setting in config.php attempts to detect the default root path of all your documents using the php variable setting - {$_SERVER<nowiki>[</nowiki>'DOCUMENT_ROOT']}. In most cases you can leave this and just modify the remainder of this string to match the directory name you have put the LimeSurvey scripts in.
*'''publicdir:''' This should be set to the physical disk location of your 'public scripts'.
*'''tempdir:''' This should be set to the physical disk location of your /limesurvey/tmp directory so that the script can read and write files.
*'''sCKEditorURL:''' url of the fckeditor script
*'''fckeditexpandtoolbar:''' defines if the FCKeditor toolbar should be opened by default
*'''pdfexportdir:''' Directory with the tcpdf.php extensiontcpdf.php
*'''pdffonts:''' Directory for the TCPDF fonts
</translate>