Difference between revisions of "Global settings"
From LimeSurvey Manual
(Add "IP whitelist for login or token access")
|Line 7:||Line 7:|
'''Configuration ''''''Global settings'''
|Line 15:||Line 15:|
The global settings dialog is only available to those administration users with the [[Manage_users#Setting_global_permissions_for_a_user|Settings & Plugins permission]]. It can be used to adjust certain settings of LimeSurvey in a global context. Once you enter the global settings dialog and save your desired configuration, the previous LimeSurvey values will be
The global settings dialog is only available to those administration users with the [[Manage_users#Setting_global_permissions_for_a_user|Settings & Plugins permission]]. It can be used to adjust certain settings of LimeSurvey in a global context. Once you enter the global settings dialog and save your desired configuration, the previous LimeSurvey values will be .
=Settings and their explanation= <!--T:4-->
=Settings and their explanation= <!--T:4-->
Revision as of 14:03, 27 May 2021
To access global settings options: Configuration -> Settings -> Global settings
The global settings dialog is only available to those administration users with the Settings & Plugins permission. It can be used to adjust certain settings of LimeSurvey in a global context. Once you enter the global settings dialog and save your desired configuration, the previous LimeSurvey values will be over written.
Settings and their explanation
- Overview: provides the following general information about your LimeSurvey installation:
- Users: shows the number of users that can access the LimeSurvey installation via the internal database authentication system
- Surveys: shows the total number of (active & inactive) surveys
- Active surveys: shows the total number of active surveys (that can be accessed by other users via the web)
- Deactivated result tables: at some point, you might want to change some questions during the survey runtime. If you do this, all the prior answers associated with the respective survey will be dissociated from the newly edited survey. The data that was previously collected will be stored in 'deactivated result tables'
- Active survey participants tables: shows the number of active survey participants tables (that have a corresponding active survey)
- Deactivated survey participants tables: shows the number of deactivated survey participants tables
- Updates (Obsolete since 2.06): for automatic updates, please use the ComfortUpdate feature. In the later versions, it can be found under the Advanced tab that is located in the Configuration dialog from the main Limesurvey toolbar
- Site name: is your survey site name. This name will appear in the survey list overview and in the administration header
- Default template: This setting specifies the default design template used for the 'public list' of surveys and for new surveys or surveys using a non-existing template. If you would like to use a personalized template, read about how you can use the LimeSurvey's template editor
- Administration template: This setting specifies the default design template used for the LimeSurvey administration. To use a customized template, add it in '/limesurvey/upload/admintheme/'
- Time difference (in hours): 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 I got 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 time of the web server. This setting is particularly important when surveys timestamp the responses*Session lifetime (seconds) (only available with database sessions): Defines the time in seconds after which a survey session expires (provided there is no action from the participant). When using regular, file-based sessions, it is up to the system administrator to define the right values for 'session.gc_maxlifetime', 'session.save_path', etc., in the PHP configuration. Not only the web server settings but also the other similar settings of other applications may overwrite the setting for file-based sessions when editing it locally via the application. The maximum value that can be introduced is 65000 (seconds). It is recommendable to use a reasonable value. Bear in mind that, when using database sessions, check whether the MySQL setting called max_allowed_packet is set to a large value because some surveys generate over 2 MB of session data
- IP Info DB API Key: Allows integration with the IP-Info-DB service, which let's you determine the geographic location of survey takers based on their IP. To use a key, you need to register for the API*Google Maps API Key: Allows for integration with Google Maps
- Google Translate API Key: The Auto Translate feature uses version 2 of Google Translate's API. Google charges for this service. In order for the Auto Translate feature to work, get an API key from this site, and then enter the key in this field
- Character set for file import/export: You can specify the character set most suiting you and your system, if you experience problems with the exporting/importing functions*Side-menu behavior (Obsolete since 3.0): How the side-menu should behave while editing surveys. The default value is 'Adaptive', meaning that the side-menu can be changed when and how the users want. The other values are 'Always open' and 'Always closed'
- Default HTML editor mode: Sets the default mode for integrated HTML editor. The valid settings are:
- inline (default): Inline replacement of fields by an HTML editor. Slow, but convenient and user-friendly
- popup : Adds an icon that opens a popup window with the HTML editor. Faster, but the HTML code is displayed on the form
- HTML source : No HTML editor used, just the plain html source
- Question type selector: Choose 'Full selector' to get a question type selector with preview and 'Simple' to get a plain select box
- Template editor: Choose 'Full template editor' to get an enhanced editor (with syntax-highlighting) when editing survey templates and 'Simple template editor' to get a plain editor field
- Default site admin email: This is the default email address of the site administrator and it is used for system messages and contact options
- Administrator name: The real name of the site administrator
- Email method: This determines how emails are being sent. The following options are available:
- PHP (default value): uses internal PHP mail function
- Sendmail : uses sendmail mailer
- SMTP : based on SMTP relaying. Use this setting when you are running LimeSurvey on a host that is not your mail server
- Make sure that you are using your SMTP configured email (Global settings -> Email settings) if you use SMTP, otherwise there might be a chance that the following error is displayed: 'SMTP -> ERROR: RCPT not accepted from server: 553 5.7.1 : Sender address rejected: not owned by user'
- Qmail : Set this if you are running the Qmail mailer*SMTP host: If you use 'SMTP' as email method, then you have to put your SMTP server here. If you are using a different port than port 25 (standard for SMTP), then you have to add the port number separated be a colon (example: 'smtp.gmail.com:465')
- SMTP username: If your SMTP-server needs authentication, set this to your user name, otherwise it must be blank
- SMTP password: If your SMTP-server needs authentication, set this to your password, otherwise it must be blank
- SMTP encryption - Three options are available:
- Off (default value)
- TLSCheck the following link for further details about SSL/TLS.
- SMTP debug mode - It comes with three options:
- Off (default value): The user wants this activated only in the case in which the SMTP relay does not work and further details are needed in order remedy the technical problem
- On errors : A detailed connection log and error message will be given if an error occurs
- Always : It gives valuable information on how a SMTP relay works. If an error occurs, further details are provided
*Email batch size: When sending invitations or reminders to survey participants, this setting helps the administrator 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 in one go 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 email batch size using this setting. Clicking the 'send email invitation' button that is located on the survey participant toolbar sends one batch of invitations, displaying a list of the addresses to which the email was already delivered 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. So, 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 invitations.
- Default site bounce email: This is the email address where bounced emails will be sent to. For faster bounce back processing, the email address box should be limited to bounce back only
- Server type: If set to 'Off', no bounce processing functions will be available. To activate the bounce processing function at a global level, set this to 'POP' or 'IMAP' - think of whether you wish the bounced emails to be kept on your email server (IMAP) or not (POP) after reading them. For further details on its usage, check the following wiki section*Server name & port: Name of the server and (if needed) the port separated by a colon. The port number isn't typically needed unless the email host uses a non-standard port
- User name: The user name for the POP/IMAP account
- Password: The password for the POP/IMAP account
- Encryption type: If encryption is used, please set the right type here (SSL or TLS)
- Survey preview only for administration users: By default, the preview of inactive surveys is restricted only to authenticated. If you set this to 'No', any person can test your survey using the survey URL - without logging in to the administration and without having to activate the survey first
- Disable question script for XSS restricted user (New in 4.1.0 ): Set to 'on' by default, this mean simple user can not add or update scripts in question editor. they can see it but don't update it. If you disable XSS protection : then this settings are not used. If you set it to 'off', then even with XSS filtering active : any user can add or update script in question.
- Group member can only see own group: By default, non-admin users defined in the LimeSurvey management interface will only be able to see other users only if they belong to at least one common group. If the administrator sets this to 'No', then the users can see all the users defined in the LimeSurvey User Control panel, regardless of the group they belong to
- IFrame embedding allowed: This option can be used to indicate whether or not a browser should be allowed to render the survey page in a <frame>, <iframe> or <object>. You can use this to avoid clickjacking attacks, by ensuring that your survey is not embedded into other sites. If you set it to 'Allow' (the default value), there is no restriction. Setting this to 'Same origin' will make the content to be loaded only if the survey runs on the same domain and port as the including <frame>, <iframe> or <object>
- Force HTTPS: This is set by default to "Don't force on/off". Switch the setting to "On" to force the connection to use HTTPS
- IP whitelist for login or token access: This option can be used to exclude specific IPs from "max login attempts" checks done on the login screen as well as on the token access screen, so requests from those IPs are not blocked.
- Show question number and/or question code: What to be shown to the survey participants - the question number and/or the question code, both or none. There is also a fifth option in which this option can be selected by the survey admin. The question code is shown next to each question from the survey
- Repeating headings in array questions every X subquestions: If you use array type questions, you'll often have a lot of subquestions, which - when displayed on screen - take up more than one page. The repeat-headers setting lets you decide how many answers should be displayed before repeating the header information for the question. A good setting for this is around 25. If you don't want the headings to repeat at all, set this to 0*Show "There are X questions in this survey": It shows the number of questions the survey contains to the user participants. The number of the questions is shown in the moment in which someone wishes to start the survey.
- Font size of PDFs: 9 is the default size for normal text. The group title font size is the value introduced in this box plus two, while the font size of the survey's title is the value introduced in this box plus four. In the default case scenario, the PDF uses a font size of 9 for normal text, of 11 for group titles, and of 13 for the title of the survey
- Width of PDF header logo: the 'dimension' of the PDF header logo. The logo appears only on the PDF file that includes the answers of the survey participants to a survey - a survey participant may wish to export his answers after completing the survey.
- PDF header title: If it is left empty, the site name will be used. The PDF header title appears only on the PDF file that is the result of the survey participant's wish to export his answers after completing a survey.
- PDF header string: If empty, the survey name will be used. The PDF header string appears only on the PDF file that is the result of the survey participant's wish to export his answers after completing a survey.*Show question group title and/or description: It works in the same manner as the Show question number and/or question code function.
- Show 'no answer' option for non-mandatory questions: When a radio button/select type question that contains editable answers (i.e.: List & array questions) is not mandatory and the "show 'no answer'" is also enabled (default), an additional entry "No answer" is shown for each subquestion - so that survey respondents may choose not to answer the question. You can select from the global settings one of the following options:
- Selectable : If the LimeSurvey administrator selects it, a survey administrator can choose whether his/her own survey displays the "no answer" option for non-mandatory questions or not (see the Presentation wiki section for more details)
- On (default value): If this option is chosen, all non-mandatory questions will contain the "no answer" option - this cannot be changed by the survey administrator because the global settings trump survey settings
- Off : If off, the non-mandatory questions will not display any "no answer" option - this cannot be changed by the survey administrator because the global settings trump the survey settings*Show header in answers export PDFs: Turn it off (default) if you would like to see nothing in the header of the PDF that contains the answers of the respondents. If it is turned on, the following information will be displayed in the header of the PDF that contains the respondents' answers
- Add gray background to questions in PDF: It is turned 'On' by default. This function refers to export-responses PDFs.
- PDF questions in bold: It is turned 'Off' by default. This functions refer to export-responses PDFs.
- Borders around questions in PDF: It is turned "On" by default. This function refers to export-responses PDFs.
- Borders around responses in PDF: It is turned "On" by default. This function refers to export-responses PDFs.'
- Show data policy on the surveylist page:: Whether to display the "data policy" button on the surveylist. On click this will display a button that shows a popup box(modal) with the "data policy" message.
- Show legal notice on the surveylist page: Whether to display the "legal notice" button on the surveylist. On click this will display a button that shows a popup box(modal) with the "legal notice".
- Data policy: Fill in the textbox to add all the information related to your legal notice (e.g., rights, duties obligations).
- Legal notice: Fill in the textbox to add all the information related to your survey data policy (e.g., where the data is stored, for how long, and so on).
- Default site language: The default language that is used in your administration panel can be selected via this option. It also gives the default language for the public survey list if none is given
- Available languages: If you don't want all languages to be available in the 'default site language' box, just remove them from the left box. This restrict the available language in survey by administrator.
- RPC interface enabled: Using this feature you can activate/deactivate the LimeSurvey RemoteControl2 interface API, either using JSON-RPC (recommended) or XML-RPC
- URL: http://<your_domain>/<your_limesurvey_dir>/index.php/admin/remotecontrol
- Publish API on /admin/remotecontrol: If you activate this option, then under the specified URL a short description of the API functions will be available. Usually, you should not need to activate it and should only be activated for debug purposes in general.