Valgfrie indstillinger

Det følgende afsnit er rettet til dem af jer, der gerne vil redigere de konfigurationsindstillinger, der ikke kunne ændres ved hjælp af GUI (Graphical User Interface) i LimeSurvey-installationen. Vær venligst opmærksom på, at alle ændringer fra LimeSurvey-rodmappen sker på egen risiko. Ikke desto mindre, hvis du oplever problemer/har brug for yderligere vejledning, skal du deltage i diskussionsfora eller IRC kanal for hjælp fra LimeSurvey-fællesskabet.

Introduktion

For at ændre installationens konfigurationsindstillinger skal du redigere de valgfrie indstillinger. De kan findes i /application/config/config-defaults.php, som er placeret i LimeSurvey-rodmappen. Standardindstillingerne for standardinstallationen kan findes i config-defaults.php. Nogle af dem kan tilsidesættes ved at bruge dialogen globale indstillinger, mens de andre skal redigeres manuelt.

  Hvis du vil ændre disse indstillinger, så lad være med at ændre dem i config-defaults.php, men kopier den bestemte indstilling/linje til /application/config/config.php i 'config'=>array( ) og ændre det der. Alle de nyligt ændrede/indførte indstillinger fra config.php-filen vil tilsidesætte standardværdierne fra config-defaults.php.

Når en opgradering sker, ændres kun indstillingerne for config-defaults.php. Derfor vil redigering af config.php filen gemme dine tilpassede indstillinger.

For at opdatere/tilføje LimeSurvey-indstillingerne i /application/config/config.php, skal du opdatere config-arrayet:

 
 'config'=>array(
 'debug'=>0,
 'debugsql'=>0,
 'LimeSurveySetting'=>'Ny værdi', // Opdater standard LimeSurvey-konfiguration her
 )

Yii indstillinger

LimeSurvey bruger Yii frameworket, som har sine egne konfigurationsparametre i application/config/internal.php og application/config/config.php fil. Du kan også få adgang til nogle specifikke konfigurationsindstillinger af LimeSurvey via Yii-konfigurationen.

Da config.php-arrayet er flettet til hele konfigurationen, kan du erstatte alle Yii-parametre i config.php-filen.

De Yii-specifikke indstillinger er indstillet i komponentarrayet:

 
 'components' => array(
 'db' => array(
 ....
 ),
 'Specific settings'=>array(
 ....
 ),
 ),

Databaseindstillinger

Databaseindstillingerne skrives til config.php af installationsfilen, når du installerer LimeSurvey for første gang. Hvis det er nødvendigt, kan du opdatere denne del af filen config.php. Husk at du gør dette på egen risiko! Se også Yii-dokumentationen og venligst husk, at LimeSurvey kun understøtter følgende typer databaser: mysql, pgsql, dblib, mssql og sqlsrv.

Sessionsindstillinger

Du kan indstille nogle sessionsparametre i config.php (tjek de to eksempler nedenfor). Du kan fjerne kommentarer/tilføje den nødvendige del i config.php. Se Yii-dokumentationen for andre indstillinger.

  Hvis du har brug for at opdatere sessionsindstillinger for at have flere LimeSurvey-forekomster kørende på den samme server, skal du kontrollere, om du ikke skal opdatere request settings for crsf-cookie.

Brug tabelbaserede sessioner

LimeSurvey kan bruge tabel-baserede sessioner, du finder en kommenteret del på den standard config.php genererede fil. For at bruge tabelbaseret session skal du fjerne // før hver linje.

 'session' => array (
 'class' => 'application.core.web.DbHttpSession',
 'connectionID' => 'db',
 'sessionTableName' => '{{sessioner} }',
 ),

  Tabelbaserede sessioner understøttes i øjeblikket ikke på MSSQL-serveren.

Opdatering af andre sessioner

Hvis du bruger SSL ('https') til din LimeSurvey-installation, vil tilføjelse af følgende linjer til din config.php øge sikkerheden for sessionen:

 // Indstil cookien via SSL
 'session' => array (
 'cookieParams' => array(
 'secure' => true, // brug SSL til cookies
 'httponly' => true // Cookies må ikke bruges af andre protokoller - eksperimentelle
 ),
 ),

Hvis du vil rette domænet til en cookie, skal du bruge følgende syntaks i config.php:

 // Indstil domænet til cookie
 'session' => array (
 'cookieParams' => array(
 'domain' => '.example.org',
 ),
 ),

Hvis du har flere installationer på den samme server, kan det være hurtigere og nemmere at indstille forskellige sessionsnavne for hver LimeSurvey-instans. Dette kan være nødvendigt for IE11 i en eller anden tilstand (se issue 12083)

 // Indstil navnet på sessionen
 'session' => array (
 'sessionName' => "LimeSurveyN1",
 ),

Anmodningsindstillinger

Anmodningsindstillingerne er vigtige, men standardindstillingerne er allerede optimeret til LimeSurvey-brug. For at læse mere om dem, se Yii Documentation.

For eksempel kan LimeSurvey-anmodningsindstillingernes konfiguration ændres på følgende måde (på eget ansvar) :

 // Deaktiver CSRF-beskyttelse
 'request' => array(
 'enableCsrfValidation'=>falsk, 
 ),

 // Håndhæv en bestemt URL-base 
 'request' => array(
 'hostInfo' => 'http://www.example.org/' 
 ),

 // Indstil cookie-domænenavnet og stien til CSRF-beskyttelse, stien bruges hvis du har en anden instans på samme domæne
 'request' => array(
 'csrfCookie' => array( 
 'domain' => '.example.com',
 'path' => '/limesurvey/',
 ) 
 ),

Hvis du kun skal opdatere url'en for token-e-mails, skal du indstille din publicurl i din config.php-fil.

Tillad brug af session og Csrf-validering i iFrame ^{(New in 3.24.3 )}

Efter at have tilladt Iframe-indlejring skal du opdatere en eller anden konfigurationsdel. Bemærk, selv med alle indstillinger: tillad form i iframe kan gå i stykker på nogle browsere. Disse indstillinger blev testet med Firefox 81.0.2 og Chromium 85.0.4183.121.

Tillad sessionstart i iframe

Sessionen skal være sikker (gyldig https), httponly og samesite to None. Alle indstillinger skal indstilles til alle små bogstaver.

'session' => array (
 'sessionName'=>'LS-VBXZZORFJZCAKGYI',
 // Fjern kommentarer på følgende linjer, hvis du har brug for tabelbaserede sessioner.
 // Bemærk: Tabelbaserede sessioner er i øjeblikket ikke understøttet på MSSQL-serveren.
 // 'class' => 'application.core.web.DbHttpSession',
 // 'connectionID' => 'db',
 // 'sessionTableName' = > '{{sessions}}',
 'cookieParams' => array(
 'secure' => sand,
 'httponly' => sand,
 'samesite' => 'Ingen' ,
 ),
 ),

Tillad csrf-cookie i iframe

Samme som session: skal være sikker og samesite indstillet til Ingen. Hele arrayet skal tilføjes på samme niveau som session.

'request' => array(
 'enableCsrfValidation'=>true,
 'csrfCookie' => array(
 'sameSite' => 'Ingen',
 'secure' => sand,
),
 ),

URL-indstillinger

  Hvis du kun har brug for at opdatere url'en for token og andre e-mails, skal du indstille din publicurl i din config.php-fil.

For at ændre standard-URL-indstillingerne skal du opdatere urlManager:

 // Brug kort URL
 'urlManager' => array(
 'urlFormat' => 'sti',
 'showScriptName' => falsk,
 ),

Du kan også tilføje .html efter undersøgelses-id'et på følgende måde:

 // Brug kort URL
 'urlManager' => array(
 'urlFormat' => 'sti',
 'rules' => array (
 '<sid:\d+> ' => array('survey/index','urlSuffix'=>'.html','matchValue'=>true),
 ),
 'showScriptName' => falsk,
 ),

For mere information, se Yii-dokumentationen.

Logningsindstillinger

Yii tilbyder forskellige løsninger til at generere logfiler. For at finde ud af mere om dem, tjek special topic. LimeSurvey bruger som standard '1' eller '2', hvilket giver enhver webbruger mulighed for at se logfilerne. Du kan oprette dine egne indstillinger ved at bruge Yii direkte.

For eksempel er en hurtig løsning til at logge fejl og advarsler i filer:

 
retur array(
 'components' => array(
 /* Anden komponentdel her 'db' for eksempel */
 'log' => array(
 'routes' => array(
 'fileError' => array(
 'class' => 'CFileLogRoute',
 'levels' => 'advarsel, fejl',
 'except' => 'exception.CHttpException .404',
 ),
 ),
 ),
 /* Anden komponentdel her 'urlManager' for eksempel */
 ),
 /* Sidste del (med ' runtimePath' 'config' for eksempel) */
);

 Hint: Filen gemmes som standard til <code>limesurvey/tmp/runtime/application.log</code> , som er placeret i LimeSurvey-rodmappen.

  Yii bruger runtime-sti. Som standard er logfilerne tilgængelige på nettet. De kan indeholde en masse information fra din server. Det er bedre at bruge en mappe, der ikke kan tilgås via internettet. Du kan indstille det i ruter eller ved at opdatere Runtime-sti.

.

Kørselssti

Runtime-stien skal være en læsbar og skrivbar mappe for "webbrugeren". Runtimestien indeholder dog filer med potentielle sikkerhedsoplysninger, der er placeret i det offentlige webadgangsområde. LimeSurvey samler disse filer i temp-mappen i LimeSurvey-rodmappen. For at eliminere adgangen til sådanne vigtige data, kan du indstille runtime-stien uden for den offentlige webadgang ved at redigere de respektive linjer i filen /application/config/config.php:

return array(
 'components' => array(
 […]
 'runtimePath'=>'/var/limesurvey/runtime/',
 'config'=>array( 
 […]
 )
 )
)

Generelle indstillinger

• sitename: Giver dit undersøgelsessted et navn. Dette navn vil fremgå af undersøgelseslisteoversigten og i administrationshovedet. Standardværdien er 'LimeSurvey', og den kan tilsidesættes i globale indstillinger-dialogen eller redigeres i config.php.
• siteadminemail: Dette er standard-e-mailadressen for webstedsadministratoren, og den bruges til systemmeddelelser og kontaktmuligheder. Denne indstilling bruges kun som standardværdi og kan tilsidesættes i dialogen globale indstillinger.
• siteadminbounce: Dette er den e-mail-adresse, hvor afviste e-mails vil blive sendt til. Denne indstilling bruges kun som standardværdi og kan tilsidesættes af dialogen globale indstillinger.
• siteadminname: Det rigtige navn på webstedsadministratoren. Denne indstilling bruges kun som standardværdi og kan tilsidesættes i dialogboksen globale indstillinger).
• proxy_host_name: Dette er værtsnavnet på din proxyserver (den har skal nævnes, hvis du står bag en proxy, og du vil opdatere LimeSurvey ved hjælp af ComfortUpdate).
• proxy_host_port: Dette er porten på din proxyserver (det skal være nævnt, hvis du står bag en proxy, og du ønsker at opdatere LimeSurvey ved hjælp af ComfortUpdate).

Sikkerhed

• maxLoginAttempt: Dette er antallet af forsøg en bruger skal indtaste den korrekte adgangskode, før han eller hun får sin IP-adresse blokeret/låst ude. Standardværdien er 3, og den kan ændres fra config.php.
• timeOutTime: Hvis brugeren indtaster adgangskoden forkert til<maxLoginAttempt> , bliver hun eller han låst ude for<timeOutTime> sekunder. Standardværdien er 10 minutter, og den kan ændres fra config.php.
• maxLoginAttemptParticipants: Dette er antallet af forsøg en deltager skal indtaste et gyldigt token, før han eller hun får sit IP-adresse blokeret/låst ude. Standardværdien er 3, og den kan ændres fra config.php.
• timeOutParticipants: Hvis deltageren indtaster tokenet forkert for<maxLoginAttemptParticipants> , bliver hun eller han låst ude for<timeOutParticipants> sekunder. Standardværdien er 10 minutter, og den kan ændres fra config.php.
• surveyPreview_require_Auth: Indstillet til sand som standard. Hvis du indstiller dette til 'false', kan enhver person teste din undersøgelse ved hjælp af undersøgelsens URL, uden at logge ind på administrationspanelet og uden at skulle aktivere undersøgelsen først. Denne indstilling er en standardværdi og kan tilsidesættes i dialogen globale indstillinger eller redigeres i config.php.
• usercontrolSameGroupPolicy: Indstillet til sand som standard. Som standard vil ikke-administratorbrugere, der er defineret i LimeSurvey-administrationsgrænsefladen, kun kunne se brugere, de opretter, eller brugere, der tilhører mindst én samme gruppe. Standardværdien kan tilsidesættes i dialogen globale indstillinger eller redigeres i config.php.
• filterxsshtml: Denne indstilling muliggør filtrering af mistænkelige html-tags placeret i undersøgelser, grupper, og spørgsmål og svar tekster i administrationsgrænsefladen. Lad kun dette være 'false', hvis du absolut stoler på de brugere, du har oprettet til administrationen af LimeSurvey, og hvis du vil tillade, at disse brugere kan bruge Javascript, Flash Movies osv.. Superadministratorerne får aldrig deres HTML filtreret . Standardværdien kan tilsidesættes i dialogen globale indstillinger eller redigeres i config.php.
• demoMode: Hvis denne indstilling er sat til 'true' i config.php , så går LimeSurvey i demotilstand. Demotilstanden ændrer følgende ting:
  • Deaktiverer adminbrugerens detaljer og adgangskodeændring;
  • Deaktiverer upload af filer på skabeloneditoren;
  • Deaktiverer afsendelse af e-mailinvitationer og påmindelser;!N !** Deaktiverer oprettelsen af en database-dump;
  • Deaktiverer muligheden for at ændre følgende globale indstillinger: webstedsnavn, standardsprog, standard HTML-redigeringstilstand, XSS-filter.
• 'forcedsuperadmin:' Array af bruger-id med alle rettigheder på alle LimeSurvey. Disse indstillinger kan kun opdateres i filen config.php. Denne brugers rettigheder kan ikke redigeres i globale tilladelser for en bruger selv af andre tvungne superadministratorer. Som standard: bruger med disse rettigheder er bruger med id: 1. Den første bruger oprettet lige efter installationen.
• force_ssl: tvinger LimeSurvey til at køre gennem HTTPS eller til at blokere HTTPS. Se Force HTTPS i globale indstillinger admin GUI.
• ssl_emergency_override: Denne indstilling tvinger SSL fra. Hvis du har slået HTTPS/SSL til i de globale indstillinger, men din server ikke har HTTPS aktiveret, er den eneste måde at slå det fra ved at ændre en værdi i databasen direkte. Dette giver dig mulighed for at tvinge HTTPS fra, mens du ændrer de globale indstillinger for Force Secure. Dette bør altid være falsk undtagen i nødstilfælde, hvor du ændrer det til sandt, indtil du løser problemet. Denne indstilling kan kun indstilles via config.php fil.
• ssl_disable_alert: Deaktiver alarm for super-admin om utvunget SSL, hvis du virkelig ikke kan eller ikke vil tvinge ssl. Denne indstilling kan kun indstilles via filen config.php.

Ressourcer

• sessionlifetime: Definerer tiden i sekunder, hvorefter en undersøgelsessession udløber. Det gælder kun, hvis du bruger databasesessioner. Hvis du bruger databasesessioner, skal du ændre parameteren i config.php eller tilsidesætte standardværdien fra dialogboksen globale indstillinger.
• memorylimit: Dette bestemmer, hvor meget hukommelse LimeSurvey kan få adgang. '128 MB' er det anbefalede minimum (MB=Megabyte). Hvis du modtager timeout-fejl eller har problemer med at generere statistik eller eksportere filer, skal du hæve denne grænse til '256 MB' eller højere. Hvis din webserver har sat en højere grænse i config.php, vil denne indstilling blive ignoreret.

Husk venligst, at sådanne lokale indstillinger altid kan tilsidesættes af ændringerne i den globale indstillingsdialog.

For at øge hukommelsesgrænsen til 128M kan du også prøve at tilføje:

• memory_limit = 128M til din servers php.ini-hovedfil (anbefales, hvis du har adgang)
• memory_limit = 128M til en php.ini-fil i LimeSurvey-roden
• php_value memory_limit 128M i en .htaccess-fil i LimeSurvey-roden

• max_execution_time: Indstil antallet af sekunder et script må køre. Hvis dette nås, returnerer scriptet en fatal fejl. For at få lov til at eksportere store undersøgelsesdata og statistikker, forsøger LimeSurvey at indstille det som standard til 1200 sekunder. Du kan indstille en større tid eller en lavere tid, hvis det er nødvendigt. Kun tilgængelig via php-konfigurationsfil.

Appearance

• dropdownthreshold ^{(Obsolete since 2.50)}: When "R" is selected for $dropdowns, the administrator is allowed to set a maximum number of options that will be displayed as radio buttons, before converting back to a dropdown list. If there is a question that has a large number of options, displaying all of them at once as radio buttons can look unwieldy, and can become counter-intuitive to users. Setting this to a maximum of, say 25 (which is the default) means that large lists are easier to be used by the administrators for the survey participant.
• repeatheadings: With the Array question type, you'll often 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 ^{(New in 2.05 )}.
• minrepeatheadings: The minimum number of remaining subquestions that are required before repeating the headings in Array questions. The default value is 3 and it can be edited in config.php.
• defaulttemplate: This setting specifies the default theme used for the 'public list' of surveys. This setting can be overridden in the global settings dialog or edited in config.php.
• defaulthtmleditormode: Sets the default mode for the integrated HTML editor. This setting can be overridden in the global settings dialog or edited in config.php. The 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 display_columns. It can be edited in the config.php file. The valid settings are:
  • 'css' - it uses one of the various CSS methods to create columns (see the template style sheet for details);
  • 'ul' - the columns are rendered as multiple floated unordered lists (default);
  • 'table' - it uses conventional-tables-based layout;
  • NULL - it disables 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 can be overridden in the global settings dialog or edited in config.php.
• 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 I 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 can be overridden in the global settings dialog or edited in config.php.

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. For example, you ask a male 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 radio button/select type question that contains editable answers (i.e.: 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 can be overridden from the global settings dialog or edited in config.php. Valid values are:
  • '0': No;
  • '1': Yes;
  • '2': The 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: 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. The default value is 'true' - hides group name and description when all questions in the group are hidden by conditions. It can be edited in config.php.
• showpopups:  Show popup messages if mandatory or conditional questions have not been answered correctly:
  • '2' = defined by Theme option (default)
  • '1'= show popup message;
  • '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).

Numerical question type behavior

• bFixNumAuto: Numeric fields can be automatically filtered to remove all non numeric values. By default this is enable, you can disable it globally. This settings is related to Fix automatically numeric value in core theme options. It was enable for Yes, disable for Only for expression and No.
• bNumRealValue: Numeric fields used in expression manager can be fixed or not. It's fixed by default. If NUMERIC is a numerical question : disable or 0 : {NUMERIC} with bad caracters send '', enable or 1 : {NUMERIC} send all character entered. This settings is related to Fix automatically numeric value in core theme options. It was enable for Yes and Only for expression and disable for No.

Development and debugging

• debug: With this setting, you set the PHP error reporting to E_ALL. This means that every little notice, warning or error related to 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. The default value is '0' and it can be edited in config.php.
• 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 the optimization of the the number of queries. In order to activate it, change the default value to '1' from the config.php file.
• use_asset_manager: By default : debug mode disable asset manager, you can allow you to use asse manager with debug mode enable.

In the case in which you experience an error in the application, we strongly recommend to activate the debug setting in order to get a more detailed error that you can submit with the bug report:

    'config'=>array(
        'debug'=>2,
        'debugsql'=>0,
    )

If you work on plugin and need a quick way to dump variables on screen : you can use traceVar function. If debug is set : this function use CWebLogRoute to be shown on HTML page. Usage traceVar($MyVariable)

Email settings

All the settings from below can be overridden in the global settings dialog.

• 'emailmethod: This determines how email messages are being sent. The following options are available:
  • 'mail:' it uses internal PHP mailer;
  • 'sendmail:' it uses sendmail mailer;
  • 'smtp:' it uses 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 from the token control toolbar (not the button situated on the right of each token) sends the <maxemails> number of invitations, then it displays a list of the addresses of the recipients 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 out and come back at a later time to send the next batch of invites.

Statistics and response browsing

• filterout_incomplete_answers: Control the default behavior of filtering incomplete answers when browsing or analyzing responses. For a discussion on incomplete responses see our browsing survey results wiki. Since these records can corrupt the statistics, an option is given to switch this filter on or off in several GUI forms. The parameter can be edited in the config.php. The following options are available:
  • 'show': Allows you to visualize both complete and incomplete answers;
  • 'filter': It shows only complete answers;
  • 'incomplete': Show only incomplete answers.
• strip_query_from_referer_url: This setting determines if the referrer URL saves the parameter or not. The default value is 'false' (in this case, the referrer URL saves all parameters). Alternatively, this value can be set to 'true' and the parameter part of the referrer URL will be removed.
• showaggregateddata: when activated, additional statistical values such as the arithmetic mean and standard deviation are shown. Furthermore, the data is aggregated to get a faster overview. For example, 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: This feature activates PDF export for printable surveys and Print Answers. The PDF export function is totally experimental and the output is far from being perfect. Unfortunately, no support can be given at the moment - if you want to help to fix it, please get in touch with us.
  • 'usepdfexport': Set '0' to disable and '1' to enable;
  • 'pdfdefaultfont': It represents the default font that will be used by the pdf export function. The default value is 'auto'. To change it, you have to set it to one of the PDF core fonts.
  • 'alternatepdffontfile': It's an array with language keys and their corresponding font. The default font for each language can be replaced in the config.php file;
  • 'pdffontsize': it shows the font size for normal texts; For the title of the survey, it is <pdffontsize>+4, while for the group title is <pdffontsize>+2. It can be edited in the config.php file or from the [Global settings|global settings]] dialog;
  • 'notsupportlanguages': it includes a list with the languages for which no PDF font was found. The list includes Amharic ('am'), Sinhala ('si'), and Thai ('th'), and it can be found in the config-defaults.php file;
  • 'pdforientation': Set 'L' for Landscape or 'P' for portrait format. It can be edited from the config.php file.
• Graph setting
  • 'chartfontfile': Sets the font file name that is used to create the statistical charts. The file has to be located in the fonts directory, located in the LimeSurvey root folder. It can be edited in the config.php file;
  • 'alternatechartfontfile': It's an array with language keys and their corresponding font. It can be edited in the config.php file.
• showsgqacode: This setting is used at the printable survey feature and defaults to 'false. If you set showsgqacode = 'true';, the IDs of 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 another page.

Authentication

Starting with LimeSurvey 2.05, authentication will be handled by plugins. As a result, the information below might be outdated. See the plugins wiki for most up to date information.

Authentication delegation 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 web server software to use this external authentication system, and then ask LimeSurvey to trust the user identity reported by the web server. In order to enable this feature, you have to:

• set auth_webserver to 'true' in config.php;
• enable authentication from the web server side.

Please note that:

• LimeSurvey will then bypass its own authentication process (by using the login name reported by the web server 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 that Authentication Delegation doesn't bypass the LimeSurvey authorization system by default - meaning 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 the administration panel.

A user is then granted access to LimeSurvey if and only if:

• he has been authenticated to the web server;
• 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 a huge user database, it is sometimes easier to auto-import users in the LimeSurvey database:

• auth_webserver_autocreate_user: If set to 'true', LimeSurvey will try to auto-import users authenticated by the web server 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 the full (fake) name, email, and 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, from a LDAP directory) the true full name, names, and email of a particular user. You can even customize his privileges on the system based on the groups he is allocated in the external database.

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

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();

  The optionnal 'hook_get_auth_webserver_profile' function is for advanced user usage only! For further details, please read the comments from the config-defaults.php file.

User name mapping

In the case in which 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' user name defined in your external authentication database. Then, in order to login to LimeSurvey as admin, you'll have to map your external user name (let's call it 'myname') to the admin login name in LimeSurvey. The corresponding setup is:

'config'=>array(
...
'auth_webserver_user_map' => array ('myname' => 'admin');
)

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

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

Use one-time passwords

A user can open the LimeSurvey login page at default.com/limesurvey/admin and type the username and the 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 config.php file to enable the usage of one-time passwords (default = false).

    'config'=>array(
        'debug'=>0,
        'debugsql'=>0,
        'use_one_time_passwords'=>true,
    )

More information can be found in the "Manage Users" section.

Encryption settings ^{(New in 4.0.0 )}

  Once set, encryption keys should never be changed, otherwise all encrypted data could be lost !

When update or install, this parameters was generated by LimeSurvey and set in application/config/security.php file. You can move this settings in config.php if you want or leave in security.php.

See data encryption for detail on this feature.

• encryptionkeypair
• encryptionpublickey
• encryptionsecretkey

Advanced url settings

• 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 it is used when LimeSurvey need an absolute url (for example when token emails are sent).
• homeurl: This should be set to the URL location of your administration scripts. These are located 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['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.
• tempurl: This should be set to the URL location of your "/limesurvey/tmp" directory - or to a directory in which you would like LimeSurvey to use to serve temporary files.
• uploadurl: This should be set to the URL location of your "/limesurvey/upload" directory - or to a directory in which you would like LimeSurvey to use to serve uploaded files. This allow you to set uploaded files on another url domain.

Advanced path settings

• 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['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.
• uploaddir: This should be set to the physical disk location of your /limesurvey/upload 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: This is the directory with the tcpdf.php extensiontcpdf.php.
• pdffonts: This is the directory for the TCPDF fonts.

Other advanced settings

Upload files

• allowedthemeuploads: File types allowed to be uploaded in theme editor
• allowedresourcesuploads: File types allowed to be uploaded in the resources sections, and with the HTML Editor
• allowedfileuploads ^{(New in 4.0.0 )} Global restriction on file type to be uploaded
• magic_database: ^{(New in 3.17.17 )} Allow to use a different MIME database for finfo_open. Can be updated only in config.php file. Example : /usr/share/misc/magic.mgc for redhat based linux.
• magic_file: ^{(New in 3.17.17 )} Allow to use a different file to get the array of extension by mime type than the included one. Must be a PHP file return an array. Can be updated only in config.php file.

Update

• updatable: This setting is in version.php. Can be true or false. If you set to true : when an super admin user log in : LimeSurvey checks if an update is available and show you a warning. If set to false : no check is done and you can't use ComfortUpdate.