Actions

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

From LimeSurvey Manual

No edit summary
(Updating to match new version of source page)
 
(6 intermediate revisions by 2 users not shown)
Line 2: Line 2:


== 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'''.
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 ==
== Pre-requisites ==
* 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 parameters provided by the automated installation process.
* Folder permissions PHP Modules availability should match '''LimeSurvey''' needs
* The availablity of the PHP Modules permissions should match the needs of '''LimeSurvey'''.
* Empty MySQL database should be created and the database use user should be properly privileged for it.
* An empty MySQL database should be created and the user should have the proper privileges in order to use it.


== Usage ==
== Usage ==
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'''.


<source lang="bash">
<source lang="bash">
Line 31: Line 31:
  - webapp
  - webapp


Чтобы посмотреть помощь по каждой конкретной команде, используйте следующий синтаксис:
To see the individual command help, use the following:
   console.php help <command-name>
   console.php help <command-name>
</pre>
</pre>


==Синтаксис==
== Syntax ==
<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>


*Полное имя и пароль заключенные в двойные кавычки, если они содержат пробелы или специальные символы.
* The Full Name and Password are enclosed in double quotes if they contain spaces or other special characters.
*Все прочие параметры, такие как: имя базы, тип базы, имя пользователя БД, пароль пользователя БД, и т.д. объявляются в файле '''config.php''' прежде чем скрипт будет запущен.
* 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.
*Скрипт должен быть выполнен только из директории '''WEBROOT/application/commands'''.
* The script should be executed from and in the '''WEBROOT/application/commands''' folder only.


==Пример==
== Example ==
<source lang="bash">
<source lang="bash">
cd /var/www/limesurvey/application/commands
cd /var/www/limesurvey/application/commands
Line 50: Line 50:
</source>
</source>


выведет следующий текст:
outputs the following text:
<pre>
<pre>
/var/www/limesurvey/installer/sql/create-mysql.sql
/var/www/limesurvey/installer/sql/create-mysql.sql
</pre>
</pre>
и база данных должна быть установлена.
and the database should be properly installed at the moment.

Latest revision as of 13:25, 19 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)/en&oldid=81694"