Actions

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

From LimeSurvey Manual

(Created page with "* De 'Full Name' en het 'password' staan tussen dubbele quotes als ze spaties of bijzondere tekens bevatten. * De overige parameters staan in het bestand '''config.php''' voo...")
(Updating to match new version of source page)
Line 1: Line 1:
<languages />
<languages />


== Introductie ==
== Introduction ==
Als je een automatische installatie uitvoert, alsof het een Virtuele Machine is, kunnen we LimeSurvey's (hier v2.x genoemd) CLI (Command Line interface) gebruiken. De bestanden die hierbij gebruikt worden (en die ook gebruikt worden voor het resetten van wachtwoorden) staan in de map '''WEBROOT/application/commands''', in dit geval gaat het om het bestand '''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'''.


== Voorwaarden ==
== Pre-requisites ==
* PHP CLI moet beschikbaar zijn.
* PHP CLI should be available
* '''WEBROOT/application/config/config.php''' moet beschikbaar zijn en de benodigde installatie-parameters bevatten.
* '''WEBROOT/application/config/config.php''' should be available and populated with the parameters provided by the automated installation process..
* De rechten op de beschikbare PHP Modules moeten voldoen aan wat '''LimeSurvey''' nodig heeft.
* The availablity of the PHP Modules permissions should match the needs of '''LimeSurvey'''.
* Er moet een lege MySQL database aangemaakt zijn en de rechten op de database moeten zijn verleend aan de database-gebruiker.
* An empty MySQL database should be created and the user should have the proper privileges in order to use it.


== Gebruik ==
== Usage ==
In het voorbeeld nemen we aan dat '''WEBROOT''' de waarde '''/var/www/limesurvey''' heeft.
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


Voor hulp bij een specifiek commando:
To see the individual command help, use the following:
   console.php help <command-name>
   console.php help <command-name>
</pre>
</pre>
Line 40: Line 40:
</pre>
</pre>


* De 'Full Name' en het 'password' staan tussen dubbele quotes als ze spaties of bijzondere tekens bevatten.
* The Full Name and Password are enclosed in double quotes if they contain spaces or other special characters.
* De overige parameters staan in het bestand '''config.php''' voor het uitvoeren van het script.
* 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.
* Het script mag alleen uitgevoerd worden in de map '''WEBROOT/application/commands'''.
* The script should be executed from and in the '''WEBROOT/application/commands''' folder only.


== Voorbeeld ==
== Voorbeeld ==
Line 50: Line 50:
</source>
</source>


uitvoertekst:
outputs the following text:
<pre>
<pre>
/var/www/limesurvey/installer/sql/create-mysql.sql
/var/www/limesurvey/installer/sql/create-mysql.sql
</pre>
</pre>
en de database moet succesvol zijn geïnstalleerd.
and the database should be properly installed at the moment.

Revision as of 11:35, 7 August 2017

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 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

Uitvoertekst:

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

De beschikbare commando's:
 - 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.

Voorbeeld

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.