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

Revision as of 11:11, 7 August 2017

Other languages:

Introduction

When doing automated installs (e.g. 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.
The availablity of the PHP Modules permissions 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, 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 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 at the moment.

@@ Line 3: / Line 3: @@
 == 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 (e.g. 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 == <!--T:2-->
 * 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
+* The availablity of the PHP Modules permissions availability should match '''LimeSurvey''' needs.
 * Empty MySQL database should be created and the database use user should be properly privileged for it.
 == Usage == <!--T:3-->
-For illustration purposes here we assume the '''WEBROOT''' to be '''/var/www/limesurvey'''
+For illustration purposes, we assume in our example the '''WEBROOT''' to be '''/var/www/limesurvey'''.
 <!--T:4-->
@@ Line 45: / Line 45: @@
 <!--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.
 * The script should be executed from and in the '''WEBROOT/application/commands''' folder only.
@@ Line 60: / Line 60: @@
 /var/www/limesurvey/installer/sql/create-mysql.sql
 </pre>
-and the database should be properly installed.
+and the database should be properly installed at the moment.
 </translate>