LimeSurvey Manual - User contributions [en]

Installation using a command line interface (CLI)

2014-07-13T12:30:34Z

Apmuthu: /* Syntax */

== Introduction ==
When doing automated installs like in a Virtual Machine setup, we can use use LimeSurvey's (v2.x referred to here) CLI (Command Line interface) to good effect. The files used for this purpose (and for resetting passwords as well) are in the '''WEBROOT/application/commands''' folder, the one of interest here being '''console.php'''.

== Pre-requisites ==
* PHP CLI should be available
* '''WEBROOT/application/config/config.php''' should be available and populated with the automated install's parameters.
* Folder permissions PHP Modules availability should match '''LimeSurvey''' needs
* Empty MySQL database should be created and the database use user should be properly privileged for it.

== Usage ==
For illustration purposes here we assume the '''WEBROOT''' to be '''/var/www/limesurvey'''

<source lang="bash">
cd /var/www/limesurvey/application/commands
php console.php
</source>
This will show:
<pre>
Yii command runner (based on Yii v1.1.14)
Usage: console.php <command-name> [parameters...]

The following commands are available:
- install
- message
- migrate
- plugin
- resetpassword
- shell
- webapp

To see individual command help, use the following:
console.php help <command-name>
</pre>

== What does not work ==
The following do not work:
<source lang="bash">
cd /var/www/limesurvey/application/commands
php starter.php install limeadmin pwd123 Admin admin@mydomain.com
php starter.php limeadmin pwd123 Admin admin@mydomain.com
</source>

== The following works ==
<source lang="bash">
cd /var/www/limesurvey/application/commands
php console.php install limeadmin pwd123 Admin admin@mydomain.com
</source>

It outputs the following text:
<pre>
/var/www/limesurvey/installer/sql/create-mysql.sql
</pre>

== Syntax ==
<pre>
php console.php <Admin User Name> <Admin User Password> <Full Name> <EMail ID>
</pre>

* The Full Name and password are enclosed in double quotes if they contain spaces or other special characters.
* All other parameters like DB Name, DB Type, DB User, DB Password, etc are to be populated in the '''config.php''' file before script execution.
* The script should be executed from and in the '''WEBROOT/application/commands''' folder only.

Installation using a command line interface (CLI)

2014-07-13T12:29:32Z

Apmuthu: /* The following works */

Installation using a command line interface (CLI)

2014-07-13T12:21:51Z

Apmuthu: /* The following works */

Installation using a command line interface (CLI)

2014-07-13T12:21:12Z

Apmuthu: /* Pre-requisites */

== Introduction ==
When doing automated installs like in a Virtual Machine setup, we can use use LimeSurvey's (v2.x referred to here) CLI (Command Line interface) to good effect. The files used for this purpose (and for resetting passwords as well) are in the '''WEBROOT/application/commands''' folder, the one of interest here being '''console.php'''.

== Pre-requisites ==
* PHP CLI should be available
* '''WEBROOT/application/config/config.php''' should be available and populated with the automated install's parameters.
* Folder permissions PHP Modules availability should match '''LimeSurvey''' needs
* Empty MySQL database should be created and the database use user should be properly privileged for it.

== Usage ==
For illustration purposes here we assume the '''WEBROOT''' to be '''/var/www/limesurvey'''

<source lang="bash">
cd /var/www/limesurvey/application/commands
php console.php
</source>
This will show:
<pre>
Yii command runner (based on Yii v1.1.14)
Usage: console.php <command-name> [parameters...]

The following commands are available:
- install
- message
- migrate
- plugin
- resetpassword
- shell
- webapp

To see individual command help, use the following:
console.php help <command-name>
</pre>

== What does not work ==
The following do not work:
<source lang="bash">
cd /var/www/limesurvey/application/commands
php starter.php install limeadmin pwd123 Admin admin@mydomain.com
php starter.php limeadmin pwd123 Admin admin@mydomain.com
</source>

== The following works ==
<source lang="bash">
cd /var/www/limesurvey/application/commands
php console.php install limeadmin pwd123 Admin admin@sunbit.co.in
</source>

It outputs the following text:
<pre>
/var/www/limesurvey/installer/sql/create-mysql.sql
</pre>

Installation using a command line interface (CLI)

2014-07-13T12:20:49Z

Apmuthu: /* The following works */

== Introduction ==
When doing automated installs like in a Virtual Machine setup, we can use use LimeSurvey's (v2.x referred to here) CLI (Command Line interface) to good effect. The files used for this purpose (and for resetting passwords as well) are in the '''WEBROOT/application/commands''' folder, the one of interest here being '''console.php'''.

== Pre-requisites ==
* PHP CLI should be available
* WEBROOT/application/config/config.php should be available and populated with the automated install's parameters.
* Folder permissions PHP Modules availability should match LimeSurvey needs
* Empty MySQL database should be created and the database use user should be properly privileged for it.

== Usage ==
For illustration purposes here we assume the '''WEBROOT''' to be '''/var/www/limesurvey'''

<source lang="bash">
cd /var/www/limesurvey/application/commands
php console.php
</source>
This will show:
<pre>
Yii command runner (based on Yii v1.1.14)
Usage: console.php <command-name> [parameters...]

The following commands are available:
- install
- message
- migrate
- plugin
- resetpassword
- shell
- webapp

To see individual command help, use the following:
console.php help <command-name>
</pre>

== What does not work ==
The following do not work:
<source lang="bash">
cd /var/www/limesurvey/application/commands
php starter.php install limeadmin pwd123 Admin admin@mydomain.com
php starter.php limeadmin pwd123 Admin admin@mydomain.com
</source>

== The following works ==
<source lang="bash">
cd /var/www/limesurvey/application/commands
php console.php install limeadmin pwd123 Admin admin@sunbit.co.in
</source>

It outputs the following text:
<pre>
/var/www/limesurvey/installer/sql/create-mysql.sql
</pre>

Installation using a command line interface (CLI)

2014-07-13T12:20:34Z

Apmuthu: /* Introduction */

== Introduction ==
When doing automated installs like in a Virtual Machine setup, we can use use LimeSurvey's (v2.x referred to here) CLI (Command Line interface) to good effect. The files used for this purpose (and for resetting passwords as well) are in the '''WEBROOT/application/commands''' folder, the one of interest here being '''console.php'''.

== Pre-requisites ==
* PHP CLI should be available
* WEBROOT/application/config/config.php should be available and populated with the automated install's parameters.
* Folder permissions PHP Modules availability should match LimeSurvey needs
* Empty MySQL database should be created and the database use user should be properly privileged for it.

== Usage ==
For illustration purposes here we assume the '''WEBROOT''' to be '''/var/www/limesurvey'''

<source lang="bash">
cd /var/www/limesurvey/application/commands
php console.php
</source>
This will show:
<pre>
Yii command runner (based on Yii v1.1.14)
Usage: console.php <command-name> [parameters...]

The following commands are available:
- install
- message
- migrate
- plugin
- resetpassword
- shell
- webapp

To see individual command help, use the following:
console.php help <command-name>
</pre>

== What does not work ==
The following do not work:
<source lang="bash">
cd /var/www/limesurvey/application/commands
php starter.php install limeadmin pwd123 Admin admin@mydomain.com
php starter.php limeadmin pwd123 Admin admin@mydomain.com
</source>

== The following works ==
<source lang="bash">
cd /var/www/limesurvey/application/commands
php console.php install limeadmin pwd123 Admin admin@sunbit.co.in
</source>

It outputs the following text:
</pre>
/var/www/limesurvey/installer/sql/create-mysql.sql
</pre>

Installation using a command line interface (CLI)

2014-07-13T12:17:42Z

Apmuthu: /* What does not work */

Installation using a command line interface (CLI)

2014-07-13T12:16:40Z

Apmuthu: /* Usage */

Installation using a command line interface (CLI)

2014-07-13T12:14:55Z

Apmuthu: /* Usage */

Installation using a command line interface (CLI)

2014-07-13T12:13:49Z

Apmuthu: Created page with "== Introduction == When doing automated installs like in a Virtual Machine setup, we can use use LimeSurvey's (v2.x referred to here) CLI (Command Line interface) to good effe..."

LimeSurvey Manual

2014-07-13T12:09:26Z

Apmuthu:

<languages />
<translate>

=General= 


<div style="float:right;"><div class="simplebox">
Main Chapters:
*[[Installation]]
*[[Administering LimeSurvey]]
*[[Getting Started]]
*[[Creating surveys - Introduction]]
*[[Managing Surveys]]
*[[Not Categorized and Advanced Features]]
*[[General FAQ]]
*[[LimeSurvey Glossary]]
*[[How to design a good survey (guide)]]
*[[Workarounds]]
*[[License]]
*[[Version change log]]
*[[Plugins]]
</div></div>


[http://www.limesurvey.com/ LimeSurvey] allows users to quickly create intuitive, powerful, online question-and-answer surveys that can work for tens to thousands of participants without much effort. The survey software itself is self-guiding for the respondents who are participating. This manual is thus focused at how to install the application, administer the installation, and support survey creators, administrators and report generation users alike.


There has been a big ramp-up in development the last few years leading to many new features and changes. Make sure to upgrade to the latest version to make use of the capabilities highlighted here.


Look to the far right for the main chapters of the manual. Otherwise, scroll down further to see the complete table of contents here and go directly to the topic you are interested in.


Still having trouble finding what you want? Don't forget the general '''search box''', our [[General FAQ]] and [[Workarounds]] list, and to look in our [http://www.limesurvey.org/en/forum/ discussion forums].


Remember that [http://www.limesurvey.org/ LimeSurvey] is an open-source, free software application. See something missing or incorrect? Then help us fix it. This documentation is a Wiki that can be edited by you or anyone else. Or [http://donate.limesurvey.org donate] to help support the core development group trying to make a difference.

= Manual - Table of contents= 


*[[Installation]]
**[[Optional settings]]
**[[Upgrading from a previous version]]
***[[ComfortUpdate]]
***[[Upgrade hints for version 1.92]]
**[[Installation of v2.x from CLI]]
**[[Transferring an installation]]
**[[Installation FAQ]]
**[[Installation security hints]]
*[[Administering LimeSurvey]]
**[[Global settings]]
**[[Manage users]]
**[[Manage user groups]]
**[[Label sets]]
**[[The template editor]]
**[[Localisation]]
**[[Survey Status Screen]]
**[[Central participants database]]
*[[Getting Started]]
**[[First login - Your user preferences]]
*[[Creating surveys - Introduction]]
**[[Survey settings]]
***[[Importing a survey structure]]
***[[Survey security settings]]
**[[Creating a question group]]
***[[Change group order]]
**[[Adding a question]]
***[[Question types]]
****[[Question type - Array]]
****[[Question type - Array by column]]
****[[Question type - Array dual scale]]
****[[Question type - Array (5 point choice)]]
****[[Question type - Array (10 point choice)]]
****[[Question type - Array (Increase-Same-Decrease)]]
****[[Question type - Array (Numbers)]]
****[[Question type - Array (Texts)]]
****[[Question type - Array (Yes-No-Uncertain)]]
****[[Question type - Date]]
****[[Question type - Equation]]
****[[Question type - File upload]]
****[[Question type - Gender]]
****[[Question type - Language switch]]
****[[Question type - Numerical input]]
****[[Question type - Multiple numerical input]]
****[[Question type - Ranking]]
****[[Question type - Text display]]
****[[Question type - Yes-No]]
****[[Question type - Multiple choice]]
****[[Question type - Multiple choice with comments]]
****[[Question type - 5 point choice]]
****[[Question type - List (Dropdown)]]
****[[Question type - List (Radio)]]
****[[Question type - List with comment]]
****[[Question type - Short free text]]
****[[Question type - Long free text]]
****[[Question type - Huge free text]]
****[[Question type - Multiple short text]]
***[[Change question order]]
***[[Question preview]]
***[[Adding answers or subquestions]]
**[[Setting conditions]]
***[[Expression Manager]]
****[[Expression Manager for developers]]
****[[Expression Manager HowTos]]
****[[Expression Manager Roadmap]]
****[[Expression Manager Examples]]
****[[Expression Manager Sample Surveys]]
***[[Show Logic File]]
**[[Assessments]]
**[[Quotas]]
**[[Email templates]]
*[[Managing Surveys]]
**[[Testing a survey]]
**[[Validate Survey Logic]]
**[[Activating a survey]]
**[[Running a survey safely]]
**[[Browsing survey results]]
**[[Closing a survey]]
**[[Changing an active survey]]
**[[Tokens]]
***[[Email bounce tracking system]]
**[[Iterate Survey]]
**[[Data entry]]
**[[Statistics]]
**[[Exporting results]]
**[[Exporting a survey structure]]
***[[Excel Survey Structure]]
**[[Quick-translation]]
*[[Not Categorized and Advanced Features]]
**[[SGQA identifier]]
**[[Using regular expressions]]
**[[RemoteControl 2 API]]
*[[General FAQ]]
*[[Troubleshooting]]
*[[LimeSurvey Glossary]]
*[[How to design a good survey (guide)]]
*[[Workarounds]]
**[[Workarounds: Question design, layout and templating]]
**[[Workarounds: Manipulating a survey at runtime using Javascript]]
**[[Workarounds: Survey behaviour]]
**[[Workarounds: Further solutions provided by LimeSurvey users]]
*[[License]]
*[[Version change log]]
*[[Plugins]]
**[[Authentication plugins]]
**[[Available third party plugins]]

=LimeSurvey development= 
*[[Development overview]] - General pages about LimeSurvey development
*[[LimeSurvey 1.x development documentation]]
*[[LimeSurvey 2.x development documentation]]

=Translating LimeSurvey= 


If you want to '''add new translations''' or '''correct a translation''' please follow these instructions:
*[[Translating LimeSurvey|How to translate LimeSurvey 1.x/2.x]]

=Google Summer of Code / Code-In participation= 
*[[Project Ideas for GSoC 2013]]
*[[LimeSurvey Google Code-in 2012]]
*[[LimeSurvey Google Code-in 2011]]
*[[LimeSurvey GSoC 2011]]/[[GSoC getting started]]
*[[LimeSurvey GSoC 2010]]
*[[LimeSurvey GSoC 2009]]

</translate>