Actions

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

From LimeSurvey Manual
No edit summary
 
(22 intermediate revisions by 4 users not shown)
Line 1: Line 1:
== Introduction ==
<languages />
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'''.
<translate>


== Usage ==
== Introduction == <!--T:1-->
For illustration purposes here we assume the '''WEBROOT''' to be '''/var/www/limesurvey'''
When doing automated installs (e.g. in a virtual machine setup), we can 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 == <!--T:2-->
* PHP CLI should be available
* '''WEBROOT/application/config/config.php''' should be available and populated with the parameters provided by the automated installation process.
* The availablity of the PHP Modules permissions should match the needs of '''LimeSurvey'''.
* An empty MySQL database should be created and the user should have the proper privileges in order to use it.
== Usage == <!--T:3-->
For illustration purposes, we assume in our example 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 14: Line 24:
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 23: Line 34:
  - webapp
  - webapp


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


== What does not work ==
== Syntax == <!--T:7-->
The following do not work:
<pre>
php console.php <Admin User Name> <Admin User Password> <Full Name> <EMail ID>
</pre>
 
<!--T:8-->
* The Full Name and Password are enclosed in double quotes if they contain spaces or other special characters.
* All the 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 == <!--T:9-->
<source lang="bash">
<source lang="bash">
cd /var/www/limesurvey/application/commands
cd /var/www/limesurvey/application/commands
php starter.php install limeadmin pwd123 Admin admin@mydomain.com
php console.php install limeadmin pwd123 Admin admin@mydomain.com
php starter.php limeadmin pwd123 Admin admin@mydomain.com
</source>
</source>
<!--T:10-->
outputs the following text:
<pre>
/var/www/limesurvey/installer/sql/create-mysql.sql
</pre>
and the database should be properly installed at the moment.
</translate>

Latest revision as of 12:37, 18 October 2017

Other languages:

Introduction

When doing automated installs (e.g. in a virtual machine setup), we can 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 parameters provided by the automated installation process.
  • The availablity of the PHP Modules permissions should match the needs of LimeSurvey.
  • An empty MySQL database should be created and the user should have the proper privileges in order to use it.

Usage

For illustration purposes, we assume in our example 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 the 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 the 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 at the moment.

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