Actions

Installation using a command line interface (CLI): Difference between revisions

From LimeSurvey Manual

No edit summary
(Marked this version for translation)
Line 1: Line 1:
<languages /> <translate>
<languages /> <translate>


== Introduction ==
== Introduction == <!--T:1-->
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'''.
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 ==
== Pre-requisites == <!--T:2-->
* PHP CLI should be available
* PHP CLI should be available
* '''WEBROOT/application/config/config.php''' should be available and populated with the automated install's parameters.
* '''WEBROOT/application/config/config.php''' should be available and populated with the automated install's parameters.
Line 10: Line 10:
* Empty MySQL database should be created and the database use user should be properly privileged for it.
* Empty MySQL database should be created and the database use user should be properly privileged for it.


== Usage ==
== Usage == <!--T:3-->
For illustration purposes here we assume the '''WEBROOT''' to be '''/var/www/limesurvey'''
For illustration purposes here we assume the '''WEBROOT''' to be '''/var/www/limesurvey'''


<!--T:4-->
<source lang="bash">
<source lang="bash">
cd /var/www/limesurvey/application/commands
cd /var/www/limesurvey/application/commands
Line 22: Line 23:
Usage: console.php <command-name> [parameters...]
Usage: console.php <command-name> [parameters...]


<!--T:5-->
The following commands are available:
The following commands are available:
  - install
  - install
Line 31: Line 33:
  - webapp
  - webapp


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


== Syntax ==
== Syntax == <!--T:7-->
<pre>
<pre>
php console.php <Admin User Name> <Admin User Password> <Full Name> <EMail ID>
php console.php <Admin User Name> <Admin User Password> <Full Name> <EMail ID>
</pre>
</pre>


<!--T:8-->
* The Full Name and password are enclosed in double quotes if they contain spaces or other special characters.
* 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.
* 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.
* The script should be executed from and in the '''WEBROOT/application/commands''' folder only.


== Example ==
== Example == <!--T:9-->
<source lang="bash">
<source lang="bash">
cd /var/www/limesurvey/application/commands
cd /var/www/limesurvey/application/commands
Line 50: Line 54:
</source>
</source>


<!--T:10-->
outputs the following text:
outputs the following text:
<pre>
<pre>

Revision as of 17:07, 8 April 2015

Other languages:

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 

cd /var/www/limesurvey/application/commands
php console.php

This will show: 

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>

Syntax

php console.php <Admin User Name> <Admin User Password> <Full Name> <EMail ID>
  • 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.

Example

cd /var/www/limesurvey/application/commands
php console.php install limeadmin pwd123 Admin admin@mydomain.com

outputs the following text: 

/var/www/limesurvey/installer/sql/create-mysql.sql

and the database should be properly installed.

Retrieved from "http://manual.limesurvey.org/index.php?title=Installation_using_a_command_line_interface_(CLI)&oldid=64728"