Actions

Installation using a command line interface (CLI)/pt-br: Difference between revisions

From LimeSurvey Manual

(Created page with "== Introdução == Quando fizer instalações automáticas como na configuração Máquina Virtual, nós podemos usar a da LimeSurvey (v2.x referida aqui) CLI (Comando de Linh...")
(Updating to match new version of source page)
 
(10 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<languages />
<languages />


== Introdução ==
== Introduction ==
Quando fizer instalações automáticas como na configuração Máquina Virtual, nós podemos usar a da LimeSurvey (v2.x referida aqui) CLI (Comando de Linha de Interface) tem um bom efeito. Esses arquivos usados para esse propósito (como também para reiniciar senhas) estão na pasta '''WEBROOT/application/commands''', o arquivo de interesse aqui é '''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 17: Line 17:
php console.php
php console.php
</source>
</source>
This will show:
Isso mostrará:
<pre>
<pre>
Yii command runner (based on Yii v1.1.14)
Yii command runner (based on Yii v1.1.14)
Usage: console.php <command-name> [parameters...]
Uso: console.php <command-name> [parameters...]


The following commands are available:
Os seguintes comandos estão disponíveis:
  - install
  - instalar
  - message
  - mensagem
  - migrate
  - migrar
  - plugin
  - plugin
  - resetpassword
  - reiniciar senha
  - shell
  - shell
  - webapp
  - webapp


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


== Syntax ==
== Sintaxe ==
<pre>
<pre>
php console.php <Admin User Name> <Admin User Password> <Full Name> <EMail ID>
php console.php <Nome do Administrador> <Senha do Administrador> <Nome Completo> <EMail ID>
</pre>
</pre>


* 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 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.
* The script should be executed from and in the '''WEBROOT/application/commands''' folder only.


== Example ==
== Exemplo ==
<source lang="bash">
<source lang="bash">
cd /var/www/limesurvey/application/commands
cd /var/www/limesurvey/application/commands
Line 54: Line 54:
/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.
and the database should be properly installed at the moment.

Latest revision as of 13:25, 19 October 2017

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

Isso mostrará:

Yii command runner (based on Yii v1.1.14)
Uso: console.php <command-name> [parameters...]

Os seguintes comandos estão disponíveis:
 - instalar
 - mensagem
 - migrar
 - plugin
 - reiniciar senha
 - shell
 - webapp

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

Sintaxe

php console.php <Nome do Administrador> <Senha do Administrador> <Nome Completo> <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.

Exemplo

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.