Note: You are currently viewing documentation for Moodle 2.3. Up-to-date documentation for the latest stable version is available here: Administration via command line.

Administration via command line

From MoodleDocs

Template:Moodle 2.0 Some large scale deployments or special distributions may prefer command line environment when installing or upgrading Moodle. All command line tools are located in admin/cli/*

 Note: This page is a work in progress, please use comments page for improvement suggestions.

Installation

Advanced cli installation script.

Command line Moodle installer, creates config.php and initializes database.
Please note you must execute this script with the same uid as apache
or use chmod/chown after installation.
Site defaults may be changed via local/defaults.php.
Options:
--lang=CODE           Installation and default site language.
--wwwroot=URL         Web address for the Moodle site, required in non-interactive mode.
--dataroot=DIR        Location of the moodle data folder, must not be web accessible. Default is moodleroot in parent directory.
--dbtype=TYPE         Database type. Default is mysqli
--dbhost=HOST         Database host. Default is localhost
--dbname=NAME         Database name. Default is moodle
--dbuser=USERNAME     Database user. Default is root
--dbpass=PASSWORD     Database password. Default is blank
--dbsocket            Use database sockets. Available for some databases only.
--prefix=STRING       Table prefix for above database tables. Default is mdl_
--admin-password=PASS Password for the moodle admin account, required in non-interactive mode.
--non-interactive     No interactive questions, installation fails if any problem encountered.
--agreelicense        Indicates agreement with software license, required in non-interactive mode.
-h, --help            Print out this help
Example: $sudo -u wwwrun /usr/bin/php admin/cli/install.php --lang=cs

TODO:

  • environment check
  • localization

Upgrades

Command line Moodle upgrade.
Please note you must execute this script with the same uid as apache!
Site defaults may be changed via local/defaults.php.
Options:
--non-interactive     No interactive questions or confirmations
-h, --help            Print out this help
Example: $sudo -u wwwrun /usr/bin/php admin/cli/upgrade.php

Reset passwords

Reset local user passwords, useful especially for admin acounts.
There are no security checks here because anybody who is able to
execute this file may execute any PHP too.
Options:
-h, --help            Print out this help
Example: $/usr/bin/php admin/cli/reset_password.php