MoodleDocs - User contributions [en]

PHP

2024-02-02T10:44:04Z

Stronk7: Updating versions to actual ones.

{{Installing Moodle}}
PHP is the scripting language in which Moodle is developed. It is integrated with your web server. The web server detects php pages (by their extension) and sends them to PHP for execution. PHP must be installed and configured properly for Moodle to work effectively (or at all).
==PHP Versions==
* Moodle 3.0.1 and later support PHP 7, however
** Moodle 3.1 and earlier does not support PHP 7.1 or later (this means that there is currently no combination of releases of Moodle and PHP that are still supported before Moodle 3.4);
* Moodle 3.4 and Moodle 3.5 '''require''' PHP 7.0 or PHP 7.1 or PHP 7.2
* Moodle 3.6 '''requires''' PHP 7.0 or later
* Moodle 3.7 '''requires''' PHP 7.1 or later
* Moodle 3.9 '''requires''' PHP 7.2 to 7.4
* Moodle 3.11 and 4.0 '''requires''' PHP 7.3 to 8.0
* Moodle 4.1 (LTS) '''requires''' PHP 7.4 to 8.1
* Moodle 4.2 '''requires''' PHP 8.0 to 8.2
* Moodle 4.3 '''requires''' PHP 8.0 to 8.2

==PHP Settings==
Check these settings in your php.ini or .htaccess file (if you're using Apache). For settings which use ON/OFF as their values, you can substitute 1 for ON and 0 for OFF if you prefer. If you change php.ini, don't forget to restart the server.
* ''memory_limit'' needs to be at least 96M (although some functions may not work if this low). Moodle will refuse to install if lower. 128M is recommended. Large systems may need an even higher setting.
* ''session.save_handler'' needs to be set to FILES.
* ''magic_quotes_runtime'' needs to be OFF. (DEPRECATED in PHP 5.3.0, and REMOVED as of PHP 7.0.0.)
* ''file_uploads'' needs to be ON.
* ''session.auto_start'' needs to be OFF.
* The temp folder must be defined and writeable by your webserver user
* Check the error display/logging section. Make sure the settings are appropriate for your server use.
* ''post_max_size'' and ''upload_max_filesize'' restrict the maximum file size that can be uploaded.
* Check the ''[mail function]'' and database section (for your chosen database) to make sure they match your server configuration.
==HTTP_RAW_POST_DATA errors==
Some users are experiencing $HTTP_RAW_POST_DATA related errors, when establishing connection between MNET servers or making AJAX web services requests.
<pre>
Request for server name returned empty response

line 134 of /mnet/lib.php: call to debugging()
line 115 of /admin/mnet/peers.php: call to mnet_get_public_key()
</pre>
These errors are affecting installations running moodle on PHP 5.6 version and it's a PHP bug on the '''always_populate_raw_post_data''' setting the default value to 0.

To avoid the error messages above, please change the value following setting on your php.ini file:
* '''always_populate_raw_post_data''' should be changed to '''-1'''.
For more information about this bug, see: https://bugs.php.net/bug.php?id=66763
==Finding the correct php.ini==
Sometimes it is not obvious where the php.ini file is located or you may even find more than one. To be certain run 'phpinfo' - see below. The path of the php.ini file is a few lines down in the top section.

Note that if you are using command-line (CLI) PHP for running cron (or anything else) it may be configured with a ''different'' php.ini file. To check, run the following command:
<pre>
php -i | grep php.ini
</pre>
==PHP Extensions and libraries==
The following PHP extensions are required or recommended (some, e.g. iconv, ctype and tokenizer are now included in PHP by default). Others will need to be installed or selected.
==== Required extensions ====
* '''ctype'''
* '''curl'''
* '''dom'''
* '''gd'''
* '''iconv'''
* '''intl'''
* '''json'''
* '''mbstring'''
* '''pcre'''
* '''simplexml'''
* '''spl'''
* '''xml'''
* '''zip'''
* The appropriate extension for your chosen database is also required ('''pgsql''', '''mysqli''', '''sqlsrv''', '''oci8''', or '''pdo''')
* Other PHP extensions may be required to support optional Moodle functionality, especially external authentication and/or enrolment (e.g. LDAP extension for LDAP authentication and the sockets extension for Chat server).
==== Recommended extensions ====
* '''openssl''' (required for networking and web services)
* '''soap''' (required for web services)
* '''sodium''' (required on PHP 8 and above)
* '''tokenizer'''
* '''xmlrpc''' (required for networking and web services)
==Installing (missing) extensions==
This depends on how PHP was installed on your machine and what access you have. Here are some possibilities:
* The extension might be installed but not enabled; you can enable it in php.ini with the <code>extension=<extension-name></code> [https://www.php.net/manual/en/ini.core.php#ini.extension directive].
* If this is a hosted server you are likely to have to ask the administrator or hosting company.
* If PHP was compiled from source you will need to recompile, changing the 'configure' settings - see [[Compiling PHP from source]].
* If it was installed using packages (typically Linux) you can install the required package (see your Linux distribution's documentation)
* If you are using Windows you just need to uncomment the appropriate DLL files in php.ini
After making any changes or additions, don't forget to re-start your web server.
== .htaccess files ==
If you don't have access to the php.ini file or there are conflicting requirements with other PHP applications on the same server you may be able to change PHP settings in an .htaccess file. This should be placed in the 'root' of your Moodle installation (i.e. the same place as the config.php file).

'''The file isn't always called .htaccess and may not work at all. Contact your server administrator to be sure'''

Settings are made by adding lines in one of two formats:
* php_value ''name value''
* php_flag ''name on/off''
Examples:
* '''php_value memory_limit 128M'''
* '''php_flag register_globals off'''
==PHP info==
The phpinfo display contains information about the configuration of your PHP installation. This is useful for checking:
* that your PHP installation meets Moodle's system requirements.
* the values that are currently applied to your server's PHP install, e.g. File upload limits
* that you have installed the required modules needed for Moodle to work, e.g. the LDAP module for LDAP authentication.
=== Displaying phpinfo in Moodle===
An administrator can find PHP info in ''Settings > Site administration > Server > PHP info''.
=== Displaying phpinfo outside of Moodle ===
To view the phpinfo information:
* Create a file called info.php using your text editor, containing this single line:
<code php>
<?php phpinfo(); ?>
</code>
* Save this file as info.php
* Upload this file into the root web accessible folder on your server.
* Now open this file in your browser. For example <nowiki>http://<server-name>/info.php</nowiki>.
==See also==
*[[Compiling PHP from source]]
* [https://docs.moodle.org/dev/Moodle_and_PHP7 Moodle and PHP7] in the developers documentation
*http://www.php.net/ - the PHP web site
*[https://php.iis.net/ http://php.iis.net/] - Microsoft PHP Installer for IIS
* [[MoodleDocs:Style_guide#PHP_syntax_highlighting]] to highlight PHP syntax
* [[Code syntax highlighting]] that uses the GeSHi (Generic Syntax Highlighter) filter.
[[de:PHP]]
[[es:PHP]]

User talk:Eloy Lafuente (stronk7)

2024-01-06T16:53:14Z

Stronk7: Created page with "test talk page"

test talk page

admin/environment/custom check/db prefix too long

2023-09-10T15:30:30Z

Stronk7: Created page with "Since Moodle 4.3, the max allowed length for the database tables prefix (<tt>$CFG->prefix</tt>) are 10 characters. If your database is using longer prefixes, you will need to..."

Since Moodle 4.3, the max allowed length for the database tables prefix (<tt>$CFG->prefix</tt>) are 10 characters.

If your database is using longer prefixes, you will need to rename all the tables to use a new, shorter, prefix.

References:
* [https://moodledev.io/general/releases/4.3#database-requirements Moodle 4.3 release page database requirements].
* MDL-76459

admin/environment/custom check/php not 64 bits

2023-01-02T15:42:55Z

Stronk7: amend

This message means that your current [[PHP]] version is not 64 bits.

A new feature of PHP7 is it has now 64-bit version so it can use more than 4GB RAM and code performance can be potentially two times faster depending on the application design.

{{Note|Since Moodle 4.2 it's required to use a 64-bit version of PHP and the underlying Operating System.}}

[[es:admin/environment/custom check/php not 64 bits]]

admin/environment/custom check/php not 64 bits

2023-01-02T15:40:02Z

Stronk7:

This message means that your current [[PHP]] version is not 64 bits.

A new feature of PHP7 is it has now 64-bit version so it can use more than 4GB RAM and code performance can be potentially two times faster depending on the application design.

{{Note|Starting with Moodle 4.2 only 64bits Operating Systems and PHP installations are supported.}}

[[es:admin/environment/custom check/php not 64 bits]]

MNet

2023-01-02T10:29:29Z

Stronk7: amend position of previous change

{{Authentication}}
The Moodle network feature allows a Moodle administrator to establish a link with another Moodle or a Mahara site and to share some resources with the users of that Moodle. Users go from the first Moodle to the linked site via the [[Network servers block]].

[[File:Networkserversexample.png]]

==Overview==
The initial release of MNet is bundled with a Authentication Plugin, which makes single-sign-on between Moodles possible. A user with the username jody logs in to her Moodle server as normal, and clicks on a link that takes her to a page on another Moodle server. Normally, she would have only the privileges of a guest on the remote Moodle, but behind the scenes, single-sign-on has established a fully authenticated session for Jody on the remote site.

{{Template:XMLRPC Note Moodle 4.1}}

'''WARNING:''' MNet requires the use of '''xmlrpc'''. Please go to your phpinfo page if you are interested in using this and search for --with-xmlrpc. If your php has not been compiled with xmlrpc then you need to address that first! At present it appears that PEAR xmlrpc will not work.
[[Image:Administration Block Users Authentication MoodleNetwork.jpg|thumb|MNet setting in ''Admin > User > Authentication > Moodle Network]]

==Security==
The MNet feature requires that your server has the '''Curl''' and '''OpenSSL''' extensions installed. Your system will generate a OpenSSL certificate for encrypted communication with other Moodles, and will rotate encryption keys on a monthly basis (approx).

Communication takes place over an XML-RPC transport, and the XML-RPC documents are wrapped first in an XMLDSIG (XML digital signature) envelope, and then in an XMLENC (XML encryption) envelope. The encryption all happens within PHP, and does not require an https (Apache SSL) server.

References:
*[http://www.w3.org/TR/xmldsig-core/ XML Digital Signatures]
*[http://www.w3.org/TR/xmlenc-core/ XML Encryption]

A special mode can be enabled which would allow a machine with a specified IP address to make calls to the XML-RPC layer without using either encryption or signature envelopes. This mode is provided to enable Moodle to communicate with other software systems in which the integration of signatures and encryption might be prohibitively difficult. It is not envisioned that unencrypted inter-Moodle networking will ever be enabled.

==Peer to Peer Network==

This is the basic layout of the system. It can be very useful to run one Moodle per faculty or departments, each with its own user management, and yet permit users to roam across the Moodle installs... subject to permissions of course.

===Setup===

The instructions will cover 2 Moodle installations: MoodleA and MoodleB. Both are installed correctly and have never had a Moodle Network configuration.

Note: If you experience problems, ensure debugging is turned on in ''Administration > Site administration > Server > Debugging''. Extra diagnostic messages may be displayed.

You need to first enable Networking in ''Administration > Site administration > Advanced Features''. This will add the "Networking" menu to the Site Administration menu.

# Get them to talk to each other
## Ensure ''Administration > Site administration > Server > Environment'' indicates you have curl installed
## If MoodleA and MoodleB are hosted in the same domain, ensure they have a different cookie prefix. Note that changing the cookie prefix will log you out! You can change the cookie prefix via ''Admin > Server > Session Handling''.
## On both, go to ''Administration > Site administration > Advanced Features'' and turn Networking ON.
## On MoodleA go to ''Administration > Site administration > Network > Manage peers'' - put the URL of MoodleB under "Add New Host" and click Add. The URL should include the directory where your Moodle code is located and may include the protocol as well, for example ''https://www.mymoodle.org/moodle''.
## Do the equivalent on MoodleB.
# Get user roaming going
[http://moodle.org/mod/forum/discuss.php?d=141491] ). On both servers:
### Go to ''Administration > Site administration > Plugins > Authentication > Manage authentication''. Enable ''MNet Authentication'' by clicking the 'enable' icon.
## On MoodleA go to ''Administration > Site administration > Networking > (Manage) Peers'', click on 'MoodleB', and click on the 'Services' tab. Enable SSO-IDP (SSO Identity Provider) publish and subscribe, and SSO-SP (SSO Service Provider) publish and subscribe.
## Do the equivalent on MoodleB. (By both publishing and subscribing you allow users to move freely between the two servers. By only publishing or subscribing between servers you create a one way traversal)
## On both, go to ''Administration > Site administration > Users > Permissions > Define Roles'', only roles that have "Roam to a remote Moodle moodle/site:mnetlogintoremote" will be allowed to roam. Grant the privilege as appropriate.
### eg. enabling for ''Authenticated user'' allows any authenticated user to roam between servers.
## On both servers, go to the homepage, and add the 'Network Servers' block.
## To test, it is recommended to use a different browser (even on a different machine) that is logged in to neither. Login to MoodleA with a non-administrator account that has the permissions to roam. You should see the Network Servers block, and clicking on it you should go to MoodleB with a newly autocreated account.
# Get remote enrolments going -- this is optional. It allows an administrator of MoodleB to enrol users that are "native" to MoodleB in remote courses in MoodleA, and viceversa.
## On both, go to ''Site administration > Plugins > Enrolments > Manage enrol plugins'' and enable the Mnet remote enrolments plugin (click Save). Click on 'Edit' and enable 'allow_allcourses' or select some courses or categories to be remotely enrolled.
## On the server you want to receive enrolments:
### Go to ''Site administration > Plugins > Enrolments > Manage enrol plugins''. Enable ''MNet remote enrolments'' by clicking the 'enable' icon. (For ''MNet remote enrolments'' settings info see [[MNet_remote_enrolments|MNet remote enrolments]])
## On MoodleA go to ''Admin > Networking > Peers'', click on 'MoodleB', and click on the 'Services' tab. Enable Enrolment publish and/or subscribe.
## Do the equivalent on MoodleB.
## On every course you want to allow enrolments into:
### Enter course and go to ''Administration > Course administration > Users > Enrolment methods''
### From ''Add method'' drop-down select ''MNet remote enrolments''
### On the new screen select the ''Remote host'' you want to allow enrolments from, the Role for the enrolled users, and click save. (Note: you can only add a single ''MNet remote enrolments'' method per course.)

===Using it===

# In MoodleA go to ''Admin > Networking > Remote enrolments client''. You will see MoodleB listed. Click on ''Edit enrolments'' button beside MoodleB and you will see a list of courses that MoodleB offers for remote enrolment. Click ''Edit enrolments'', select the users you want to enroll, and then click Add to enroll them in the course.

==Connecting to a Mnet hub==
A Mnet hub (do not confuse it with the [[Community hub]]) is a Moodle server that is configured to accept connections from other Moodle servers, and to provide a set of services to users of these other servers. This guideline will direct you to connect to a Mnet hub, assess the services it has to offer, and enable those services for your users.

===Setup===
# Get talking to the Hub
## Ensure that the ''Admin > Server > Environment'' page indicates you have curl and openssl installed
## Go to ''Admin > Advanced Features'' and turn Networking on
## Go to ''Admin > Network > Peers'' and enter the URL of Mnet Hub under "Add New Host". Click Add
## The host details for the Mnet Hub should appear with the Site Name field already populated. Click Save changes
## The details will be written to your database and two new tabs will appear in this window: 'Services' and 'Logs'. Click Services
##A list of services will appear, each with a checkbox for 'publish' and 'subscribe'. Check the checkboxes for any services you want to publish or subscribe to

===Using it===
If the Mnet Hub has already enabled a service for you, there will be a tick alongside the appropriate checkbox, for example: if the Hub is publishing Moodle Networked Enrolment, then a tick will appear alongside the subscribe checkbox for this service. Note that in order to enable some functionality, prominently single-sign-on, you may have to publish a service, e.g. the Identity Provider service. The Mnet Hub will access this service on your Moodle, asking it to authenticate your users.
# Enable Roaming
## Subscribe to SSO (Service Provider) by checking the box
## Publish SSO (Identity Provider) by checking the box
## Click Save changes
## Go to ''Admin > Users > Permissions > Define Roles'', and grant the capability Roam to a remote Moodle moodle/site:mnetlogintoremote to an appropriate role
## Go to ''Administration > Plugins > Authentication > Manage authentication'' and enable the Moodle Network authentication plugin
## Go to your homepage, turn on editing, and add the 'Network Servers' block
## Using a different web-browser, log on as a non-admin user who inhabits the role you granted the roaming capability to
## Note that the Mnet Hub is listed in the Network Servers block on the homepage. Click on the link to that server
## Some of your user details will be transferred to the Mnet Hub server, and a browsing session will be started for you as if you had logged on there directly
# Enable Networked Enrolment
## Return to the web browser you've been using as the site administrator
## Go to ''Admin > Network > Peers'' and click on the entry for the Mnet Hub.
## Click on the Services tab
## Subscribe to Moodle Networked Enrolment
## Go to ''Site administration > Plugins > Enrolments > Manage enrol plugins'' and enable the Mnet remote enrolment plugin. Click Save changes
## Click on edit to view the details for networked enrolments.
## Go to ''Admin > Networking > Enrolments'' to see a list of Moodle servers that offer this service to you
## Click on a server name to view a list of courses that the server offers to your users
## Click on a course name, to view a list users that you can enrol in this course
## Enrol users
## Profit!

==Running a Mnet hub==
A Mnet hub is a regular Moodle site that runs in a special mode. As a Moodle Administrator, when you add another Moodle site to your list of network peers, your Moodle will contact that site to find out what it is called, and to request its public key for encrypted communication. Normally, the remote server will simply provide this information without making any record of the transaction.

A Mnet hub is different. As soon as you add an entry for a Mnet hub to your system, the Mnet hub will create an entry for your server in its list of hosts, and may immediately begin to offer services to the users of your site.

This section will guide you to set up a Mnet hub, and select services to offer to all comers.

===Setup===
Enable Networking
# Ensure that the ''Settings > Site administration > Server > Environment'' page indicates you have curl and openssl installed
# Go to ''Settings > Site administration > Advanced Features'' and turn Networking on
# Go to ''Settings > Site administration > Network > Peers'' and tick the checkbox for Register all hosts. Click on Save Changes
# On the same page, the first entry in your list of hosts should be All hosts. Click this link
# Click on Services and enable any services you want to offer to all comers

==Assigning the role of admin==

For security reasons, users cannot be assigned the role of admin via the Moodle interface. Instead, admin user IDs must be listed in config.php e.g. <code>$CFG->siteadmins = '2,45,67';</code>

Note: This applies to local admins as well as remote admins, as this overrides any local DB stored settings that assign administrative permissions.

==See also==

* [[Moodle Network FAQ]]
* [[Upload users]] for csv upload using the ''mnethostid'' field.
* [[Development:Moodle Network|Moodle Network development notes]]
* Using Moodle [http://moodle.org/mod/forum/view.php?id=6976 MNet forum]
* Using Moodle [http://moodle.org/mod/forum/discuss.php?d=92749 Examples of how people are using Moodle networks] forum discussion

[[Category:Enrolment]]
[[Category:MNet]]

[[fr:Réseau Moodle]]
[[ja:MNet]]
[[es:Red Moodle]]
[[cs:Síťové služby]]
[[de:Moodle-Netzwerk]]

MNet

2023-01-02T10:28:43Z

Stronk7: Note about Moodle 4.1 and XMLRPC extension/webservice added

{{Authentication}}
The Moodle network feature allows a Moodle administrator to establish a link with another Moodle or a Mahara site and to share some resources with the users of that Moodle. Users go from the first Moodle to the linked site via the [[Network servers block]].

[[File:Networkserversexample.png]]

==Overview==
The initial release of MNet is bundled with a Authentication Plugin, which makes single-sign-on between Moodles possible. A user with the username jody logs in to her Moodle server as normal, and clicks on a link that takes her to a page on another Moodle server. Normally, she would have only the privileges of a guest on the remote Moodle, but behind the scenes, single-sign-on has established a fully authenticated session for Jody on the remote site.

'''WARNING:''' MNet requires the use of '''xmlrpc'''. Please go to your phpinfo page if you are interested in using this and search for --with-xmlrpc. If your php has not been compiled with xmlrpc then you need to address that first! At present it appears that PEAR xmlrpc will not work.
[[Image:Administration Block Users Authentication MoodleNetwork.jpg|thumb|MNet setting in ''Admin > User > Authentication > Moodle Network]]

{{Template:XMLRPC Note Moodle 4.1}}

==Security==
The MNet feature requires that your server has the '''Curl''' and '''OpenSSL''' extensions installed. Your system will generate a OpenSSL certificate for encrypted communication with other Moodles, and will rotate encryption keys on a monthly basis (approx).

Communication takes place over an XML-RPC transport, and the XML-RPC documents are wrapped first in an XMLDSIG (XML digital signature) envelope, and then in an XMLENC (XML encryption) envelope. The encryption all happens within PHP, and does not require an https (Apache SSL) server.

References:
*[http://www.w3.org/TR/xmldsig-core/ XML Digital Signatures]
*[http://www.w3.org/TR/xmlenc-core/ XML Encryption]

A special mode can be enabled which would allow a machine with a specified IP address to make calls to the XML-RPC layer without using either encryption or signature envelopes. This mode is provided to enable Moodle to communicate with other software systems in which the integration of signatures and encryption might be prohibitively difficult. It is not envisioned that unencrypted inter-Moodle networking will ever be enabled.

==Peer to Peer Network==

This is the basic layout of the system. It can be very useful to run one Moodle per faculty or departments, each with its own user management, and yet permit users to roam across the Moodle installs... subject to permissions of course.

===Setup===

The instructions will cover 2 Moodle installations: MoodleA and MoodleB. Both are installed correctly and have never had a Moodle Network configuration.

Note: If you experience problems, ensure debugging is turned on in ''Administration > Site administration > Server > Debugging''. Extra diagnostic messages may be displayed.

You need to first enable Networking in ''Administration > Site administration > Advanced Features''. This will add the "Networking" menu to the Site Administration menu.

# Get them to talk to each other
## Ensure ''Administration > Site administration > Server > Environment'' indicates you have curl installed
## If MoodleA and MoodleB are hosted in the same domain, ensure they have a different cookie prefix. Note that changing the cookie prefix will log you out! You can change the cookie prefix via ''Admin > Server > Session Handling''.
## On both, go to ''Administration > Site administration > Advanced Features'' and turn Networking ON.
## On MoodleA go to ''Administration > Site administration > Network > Manage peers'' - put the URL of MoodleB under "Add New Host" and click Add. The URL should include the directory where your Moodle code is located and may include the protocol as well, for example ''https://www.mymoodle.org/moodle''.
## Do the equivalent on MoodleB.
# Get user roaming going
[http://moodle.org/mod/forum/discuss.php?d=141491] ). On both servers:
### Go to ''Administration > Site administration > Plugins > Authentication > Manage authentication''. Enable ''MNet Authentication'' by clicking the 'enable' icon.
## On MoodleA go to ''Administration > Site administration > Networking > (Manage) Peers'', click on 'MoodleB', and click on the 'Services' tab. Enable SSO-IDP (SSO Identity Provider) publish and subscribe, and SSO-SP (SSO Service Provider) publish and subscribe.
## Do the equivalent on MoodleB. (By both publishing and subscribing you allow users to move freely between the two servers. By only publishing or subscribing between servers you create a one way traversal)
## On both, go to ''Administration > Site administration > Users > Permissions > Define Roles'', only roles that have "Roam to a remote Moodle moodle/site:mnetlogintoremote" will be allowed to roam. Grant the privilege as appropriate.
### eg. enabling for ''Authenticated user'' allows any authenticated user to roam between servers.
## On both servers, go to the homepage, and add the 'Network Servers' block.
## To test, it is recommended to use a different browser (even on a different machine) that is logged in to neither. Login to MoodleA with a non-administrator account that has the permissions to roam. You should see the Network Servers block, and clicking on it you should go to MoodleB with a newly autocreated account.
# Get remote enrolments going -- this is optional. It allows an administrator of MoodleB to enrol users that are "native" to MoodleB in remote courses in MoodleA, and viceversa.
## On both, go to ''Site administration > Plugins > Enrolments > Manage enrol plugins'' and enable the Mnet remote enrolments plugin (click Save). Click on 'Edit' and enable 'allow_allcourses' or select some courses or categories to be remotely enrolled.
## On the server you want to receive enrolments:
### Go to ''Site administration > Plugins > Enrolments > Manage enrol plugins''. Enable ''MNet remote enrolments'' by clicking the 'enable' icon. (For ''MNet remote enrolments'' settings info see [[MNet_remote_enrolments|MNet remote enrolments]])
## On MoodleA go to ''Admin > Networking > Peers'', click on 'MoodleB', and click on the 'Services' tab. Enable Enrolment publish and/or subscribe.
## Do the equivalent on MoodleB.
## On every course you want to allow enrolments into:
### Enter course and go to ''Administration > Course administration > Users > Enrolment methods''
### From ''Add method'' drop-down select ''MNet remote enrolments''
### On the new screen select the ''Remote host'' you want to allow enrolments from, the Role for the enrolled users, and click save. (Note: you can only add a single ''MNet remote enrolments'' method per course.)

===Using it===

# In MoodleA go to ''Admin > Networking > Remote enrolments client''. You will see MoodleB listed. Click on ''Edit enrolments'' button beside MoodleB and you will see a list of courses that MoodleB offers for remote enrolment. Click ''Edit enrolments'', select the users you want to enroll, and then click Add to enroll them in the course.

==Connecting to a Mnet hub==
A Mnet hub (do not confuse it with the [[Community hub]]) is a Moodle server that is configured to accept connections from other Moodle servers, and to provide a set of services to users of these other servers. This guideline will direct you to connect to a Mnet hub, assess the services it has to offer, and enable those services for your users.

===Setup===
# Get talking to the Hub
## Ensure that the ''Admin > Server > Environment'' page indicates you have curl and openssl installed
## Go to ''Admin > Advanced Features'' and turn Networking on
## Go to ''Admin > Network > Peers'' and enter the URL of Mnet Hub under "Add New Host". Click Add
## The host details for the Mnet Hub should appear with the Site Name field already populated. Click Save changes
## The details will be written to your database and two new tabs will appear in this window: 'Services' and 'Logs'. Click Services
##A list of services will appear, each with a checkbox for 'publish' and 'subscribe'. Check the checkboxes for any services you want to publish or subscribe to

===Using it===
If the Mnet Hub has already enabled a service for you, there will be a tick alongside the appropriate checkbox, for example: if the Hub is publishing Moodle Networked Enrolment, then a tick will appear alongside the subscribe checkbox for this service. Note that in order to enable some functionality, prominently single-sign-on, you may have to publish a service, e.g. the Identity Provider service. The Mnet Hub will access this service on your Moodle, asking it to authenticate your users.
# Enable Roaming
## Subscribe to SSO (Service Provider) by checking the box
## Publish SSO (Identity Provider) by checking the box
## Click Save changes
## Go to ''Admin > Users > Permissions > Define Roles'', and grant the capability Roam to a remote Moodle moodle/site:mnetlogintoremote to an appropriate role
## Go to ''Administration > Plugins > Authentication > Manage authentication'' and enable the Moodle Network authentication plugin
## Go to your homepage, turn on editing, and add the 'Network Servers' block
## Using a different web-browser, log on as a non-admin user who inhabits the role you granted the roaming capability to
## Note that the Mnet Hub is listed in the Network Servers block on the homepage. Click on the link to that server
## Some of your user details will be transferred to the Mnet Hub server, and a browsing session will be started for you as if you had logged on there directly
# Enable Networked Enrolment
## Return to the web browser you've been using as the site administrator
## Go to ''Admin > Network > Peers'' and click on the entry for the Mnet Hub.
## Click on the Services tab
## Subscribe to Moodle Networked Enrolment
## Go to ''Site administration > Plugins > Enrolments > Manage enrol plugins'' and enable the Mnet remote enrolment plugin. Click Save changes
## Click on edit to view the details for networked enrolments.
## Go to ''Admin > Networking > Enrolments'' to see a list of Moodle servers that offer this service to you
## Click on a server name to view a list of courses that the server offers to your users
## Click on a course name, to view a list users that you can enrol in this course
## Enrol users
## Profit!

==Running a Mnet hub==
A Mnet hub is a regular Moodle site that runs in a special mode. As a Moodle Administrator, when you add another Moodle site to your list of network peers, your Moodle will contact that site to find out what it is called, and to request its public key for encrypted communication. Normally, the remote server will simply provide this information without making any record of the transaction.

A Mnet hub is different. As soon as you add an entry for a Mnet hub to your system, the Mnet hub will create an entry for your server in its list of hosts, and may immediately begin to offer services to the users of your site.

This section will guide you to set up a Mnet hub, and select services to offer to all comers.

===Setup===
Enable Networking
# Ensure that the ''Settings > Site administration > Server > Environment'' page indicates you have curl and openssl installed
# Go to ''Settings > Site administration > Advanced Features'' and turn Networking on
# Go to ''Settings > Site administration > Network > Peers'' and tick the checkbox for Register all hosts. Click on Save Changes
# On the same page, the first entry in your list of hosts should be All hosts. Click this link
# Click on Services and enable any services you want to offer to all comers

==Assigning the role of admin==

For security reasons, users cannot be assigned the role of admin via the Moodle interface. Instead, admin user IDs must be listed in config.php e.g. <code>$CFG->siteadmins = '2,45,67';</code>

Note: This applies to local admins as well as remote admins, as this overrides any local DB stored settings that assign administrative permissions.

==See also==

* [[Moodle Network FAQ]]
* [[Upload users]] for csv upload using the ''mnethostid'' field.
* [[Development:Moodle Network|Moodle Network development notes]]
* Using Moodle [http://moodle.org/mod/forum/view.php?id=6976 MNet forum]
* Using Moodle [http://moodle.org/mod/forum/discuss.php?d=92749 Examples of how people are using Moodle networks] forum discussion

[[Category:Enrolment]]
[[Category:MNet]]

[[fr:Réseau Moodle]]
[[ja:MNet]]
[[es:Red Moodle]]
[[cs:Síťové služby]]
[[de:Moodle-Netzwerk]]

MNet FAQ

2023-01-02T10:27:02Z

Stronk7: Note about Moodle 4.1 and XMLRPC extension/webservice added

{{Authentication}}
==Moodle 4.1 and up==
{{Template:XMLRPC Note Moodle 4.1}}

==What is MNet?==
MNet is the mechanism in Moodle for connecting to other Moodle (or Mahara) sites. It's short for "Moodle networking". See [[MNet]] for more information. At some point in the future, support for MNet will end. See [http://moodle.org/mod/forum/discuss.php?d=175158 this forum discussion on MNet.]

==It doesn't work. What do I do now?==
* make sure that you have the latest version of Moodle installed.
* make sure xmlrpc is installed. Please go to your phpinfo page and search for --with-xmlrpc. If your php has not been compiled with xmlrpc then you need to address that! At present it appears that PEAR xmlrpc will not work.
* make sure that openssl is installed. Please go to your phpinfo page and search for openssl. If your php has not been compiled with openssl then you need to address that.
* make sure you have debugging turned on (Site Administration > Server > Debugging). This will greatly increase the chance of the underlying problem being reported.
* Note that MNET does not currently work on lighttpd. (MDL-14638) This should be fixed in lighttpd 1.5 when it is released.

==I've set up the keys and configured Moodle Networking, but when I try to SSO into Mahara, it doesn't work==
This problem could be due to a PHP bug in libxml2 2.7.1 (the same bug reported with version 2.7.2 and 2.7.3). check the server > PHP info page to see what version of libxml is installed - if you have one of versions mentioned - check out the FAQ here for details on how to fix it: [https://docs.moodle.org/en/Backup_FAQ#Restoring_a_course_results_in_broken_HTML_tags._What_can_I_do.3F Backup_FAQ#Restoring_a_course_results_in_broken_HTML_tags._What_can_I_do.3F]

==Moodle doesn't generate any keys on the networking pages==
This could be because PHP cannot find the openssl.cnf file on your server - this is a very common issue on windows servers. To address this you must set the path to this file in your config.php file - first find the openssl.cnf file on your server then add it's location into your config.php file like this:
$CFG->opensslcnf = 'C:/apache2/bin/openssl.cnf';
Note: this file could potentially be located anywhere on your server, just make sure the full path and name of the file is correct.

Note: this could also affect Mahara. On Mahara you can also added this to the config table in the database.

Note: this also happens on RHEL5 and RHEL5 based operating systems. The path the file is "/etc/pki/tls/openssl.cnf". RHEL is RedHat Enterprise Linux.

==I obtain the error "The signature verification failed. It appears that this payload was not signed by you."==

See [[error/moodle/rpcerror]] for how to fix the problem.

==See also==

* [http://moodle.org/mod/forum/view.php?id=6976 Moodle networking (MNet) forum] on moodle.org

Forum discussions:
* [http://moodle.org/mod/forum/discuss.php?d=105301 Overview of public key]
* [http://moodle.org/mod/forum/discuss.php?d=76600 Time Gap Error - Peer to Peer]
* [http://moodle.org/mod/forum/discuss.php?d=202535 Replace local users with mnet users]
* [https://moodle.org/mod/forum/discuss.php?d=417596 MNet remote enrollment does not work]

[[Category:MNet]]
[[Category:FAQ]]

[[de:Moodle-Netzwerk FAQ]]
[[es:MNet FAQ]]

Template:XMLRPC Note Moodle 4.1

2023-01-02T10:24:26Z

Stronk7: Add paragraph about the extension not being needed for MNet anymore.

{{Note|The installation of the '''XMLRPC PHP extension''' is not needed for Moodle 4.1 core anymore. All [[MNet]] features continue working exactly the same, but using a PHP library instead (see MDL-76055 for details).
If you were using the '''webservice_xmlrpc''' plugin for integrations with other systems, be warned that it has been removed from core for Moodle 4.1 (see MDL-76052 for details). It's now available @ https://github.com/moodlehq/moodle-webservice_xmlrpc and has been also published in the [https://moodle.org/plugins/webservice_xmlrpc Plugins directory]. Note that, if you want to continue using this plugin, then you will need, '''before starting the upgrade process''', to:
# Install the '''XMLRPC PHP extension''', the webservice requires it.
# Install the '''webservice_xmlrpc plugin''', from the links in the previous paragraph, into the <tt>webservice/xmlrpc</tt> directory.
# Then, and only then, start the upgrade process.}}

admin/environment/php extension/xmlrpc

2023-01-02T10:22:46Z

Stronk7: Add a note about the xmlrpc extension and Moodle 4.1

{{Environment}}
{{Template:XMLRPC Note Moodle 4.1}}
To install the xmlrpc library on Microsoft Windows:
#Open the ''php.ini'' file, depending on your installation this may be found in the ''moodle/apache/bin'' folder
#Find the line: <code>;extension=php_xmlrpc.dll</code>
#Remove the <code>;</code> at the beginning of the line
#If necessary restart the web server, e.g. IIS or Apache.
To install the xmlrpc library on Linux/Unix

If you are using PHP as provided by the OS, you can just install the appropriate package, and restart the service (e.g. PHP-FPM or Apache):
* On Ubuntu and Debian, the command is: apt-get install php-xmlrpc
* On RedHat, Fedora, CentOS and SuSE, the command is: dnf install php-xmlrpc
If you compiled your PHP from source:
# You need to recompile PHP from source
# add '''--with-xmlrpc''' to the command line when you run '''configure'''
==You can (usually) ignore this warning==
There are 2 features in Moodle that require that PHP extension - both are disabled by default:
# "[[MNet|Moodle networking/Mnet]]" - has been historically used for connecting multiple Moodle sites to each other, so you can share login processes, or connecting Moodle to Mahara (an e-portfolio system). MNet is generally considered deprecated and the LTI features in Moodle mostly provide replacements; however Mnet still contains some functions that are not easy to reproduce using other methods - it's unlikely it will be officially removed until the functionality Mnet currently provides can be easily replicated using other functionality.
# XMLRPC Web services protocol - If enabled, Moodle [[Using web services|web services]] allow external systems to make API calls to your Moodle site - there are a few different ways (protocols) that this data can be formatted; one of those protocols is XMLRPC and it uses the XMLRPC PHP exension to do this.

If you have not enabled either of these features, you can safely ignore the warning. PHP 8.0 has also removed the extension out of core, so Moodle is currently investigating the options of improving this warning/removing it - more info in https://tracker.moodle.org/browse/MDL-70889
[[Category:Environment|PHP extension]]
[[Category:MNet|PHP]]
[[fr:admin/environment/php extension/xmlrpc]]
[[es:admin/environment/php extension/xmlrpc]]

Template:XMLRPC Note Moodle 4.1

2023-01-02T10:18:10Z

Stronk7: Undo revision 145330 by Stronk7 (talk)

{{Note|If you were using the '''webservice_xmlrpc''' plugin for integrations with other systems, be warned that it has been removed from core for Moodle 4.1 (see MDL-76052 for details). It's now available @ https://github.com/moodlehq/moodle-webservice_xmlrpc and has been also published in the [https://moodle.org/plugins/webservice_xmlrpc Plugins directory]. Note that, if you want to continue using this plugin, then you will need, '''before starting the upgrade process''', to:
# Install the '''XMLRPC PHP extension''', the webservice requires it.
# Install the '''webservice_xmlrpc plugin''', from the links in the previous paragraph, into the <tt>webservice/xmlrpc</tt> directory.
# Then, and only then, start the upgrade process.}}

Template:XMLRPC Note Moodle 4.1

2023-01-02T10:17:17Z

Stronk7: Add Moodle 4.1 category

Capabilities/webservice/xmlrpc:use

2023-01-02T10:13:13Z

Stronk7: Added note about webservice_xmlrpc removed from core in Moodle 4.1

{{Capabilities}}
{{Template:XMLRPC Note Moodle 4.1}}
*This allows a user to use the XML-RPC protocol for [[Web services]]
*This capability is not set for any of the default roles unless the setting 'Enable web services for mobile devices' is enabled, in which case the capability is allowed for the default role of authenticated user

[[Category:Capabilities|Webservice]]
[[Category:Web Services]]

[[eu:Capabilities/webservice/xmlrpc:use]]
[[es:Capabilities/webservice/xmlrpc:use]]
[[de:Capabilities/webservice/xmlrpc:use]]

Template:XMLRPC Note Moodle 4.1

2023-01-02T10:12:53Z

Stronk7: Template note to be added to various user docs pages about the move of webservice_xmlrpc out from core in Moodle 4.1

Upgrading

2022-11-15T18:10:00Z

Stronk7: Update the information to the versions that may be involved in the upgrades (3.9 and up)

{{Installing Moodle}}
''This page explains in detail how to upgrade Moodle. For a summary of the process, see [[Upgrade overview]].''
==Check the requirements==
Before upgrading, check that your server meets all requirements for {{Version}} in ''Site administration > Server > [[Environment]]''.

See the [{{Release notes}} release notes] in the dev docs for both [{{Release notes}}#Server_requirements server] and [{{Release notes}}#Client_requirements client] software requirements.

Notes:
* You can only upgrade to Moodle {{Version}} from Moodle 3.9 or later. If upgrading from earlier versions, you must [https://docs.moodle.org/39/en/Upgrading_to_Moodle_3.9 upgrade to 3.9] as a first step.

==Before upgrading==
'''We advise that you test the upgrade first on a COPY of your production site, to make sure it works as you expect.'''

Consider setting the [[Upgrade key|upgrade key]] for your site.
== Backup important data ==
There are three areas that should be backed up before any upgrade:
#Moodle software (For example, everything in server/htdocs/moodle)
#Moodle uploaded files (For example, server/moodledata)
#Moodle database (For example, your Postgres or MySQL database dump)
See [[Site backup]] for more specific information.
== Check for plugin updates ==
If you have [[Automatic updates deployment]] enabled, you will be able to update installed plugins automatically during the upgrade. Just make sure you check for available updates (via the button for it) at the Plugins check screen.

If you are updating plugins manually, it is a good moment now to check in the [http://moodle.org/plugins Moodle Plugins directory] whether there is a {{Version}} version available for any plugins (including themes) that you have previously installed on your site. If so, download the plugin package. In the next step, you will copy it to the appropriate location in your Moodle code (see [[Installing plugins]]).

The upgrade of the plugin will then happen as part of the Moodle upgrade process.

If an out-of-date plugin causes your upgrade to fail, you can usually delete the plugin code rather than uninstalling it from within Moodle so that the data associated with it is not deleted.
==Put your site into maintenance mode==
Before you begin upgrading your site, you should put it into [[Maintenance_mode | maintenance mode]] to stop any non-admin users from logging in. Then you should wait for any currently running cron processes to complete before proceeding.
== Install the new Moodle software ==
You can download the latest release from [https://download.moodle.org/ Moodle downloads].
=== Standard install package ===
# Move your old Moodle software program files to another location. ''Do NOT copy new files over the old files.''
# Unzip or unpack the upgrade file so that all the new Moodle software program files are in the location the old files used to be in on the server. Moodle will adjust SQL and moodledata if it needs to in the upgrade.
# Copy your old [[Configuration file|config.php file]] back to the new Moodle directory.
# As mentioned above, if you had installed any plugins on your site you should add them to the new code tree (Moodle directory structure) now. It is important to check that you get the correct version for your new version of Moodle. Be particularly careful that you do not overwrite any code in the new version of Moodle and that you place the plugin folders in the correct directory (the same directory that they are in in the current installation.)
# Your moodledata folder should be located separately to your Moodle code folder and, as such, should not need anything done to it. Moodle 3.0 will throw a warning if it is located in a web accessible folder and the moodledata should never be located in the Moodle code folder. If you are moving your installation to a new server or new location on your server, then you will need to follow the [[Migration]] documents.
====Linux====
mv moodle moodle.backup
tar xvzf moodle-latest-{{Version}}.tgz
Next, copy across your config.php, any custom plugins, and your .htaccess file if you created one ('''check that custom plugins are the correct version for your new Moodle first'''):
cp moodle.backup/config.php moodle
cp -pr moodle.backup/theme/mytheme moodle/theme/mytheme
cp -pr moodle.backup/mod/mymod moodle/mod/mymod
Don't forget to make moodle/config.php (and the rest of the source code) readable by your www server. For maximum security the files should not be writeable by your server. This is especially important on a 'production' server open to the public internet.
chown -R root:root moodle (Linux debian - or even create a user especially for moodle. '''Don't''' use the web server user, e.g. www-data)
chmod -R 755 moodle
If you use cron, take care that cron.php is executeable and uses the correct php command:
chmod 740 admin/cli/cron.php (some configurations need chmod 750 or chmod 755)
copy the first line from cron.php (if it looks like '#!/usr/local/bin/php' or '#!/usr/local/bin/php5.3', no need to copy '<?php')
if necessary. However, for a simple upgrade, there should be no need to change anything with cron.
=== Using Git ===
You can use Git for updating or upgrading your Moodle. See [[Git for Administrators]] for details.
===Command line upgrade===
On Linux servers, Moodle {{Version}} supports running the [[CLI|upgrade from the command line]], rather than through a web browser. This is likely to be more reliable, particularly for large sites.
== Finishing the upgrade ==
The last step is to trigger the upgrade processes within Moodle.

If you put your site into Maintenance mode earlier; take it out now!

To do this just go to ''Site administration > Notifications''.

Moodle will automatically detect the new version and perform all the SQL database or file system upgrades that are necessary. If there is anything it can't do itself (very rare) then you will see messages telling you what you need to do.

Assuming all goes well (no error messages) then you can start using your new version of Moodle and enjoy the new features!

Note: If you are running multiple servers then you should purge all caches manually (via ''Site administration > Development > Purge all caches'') after completing the upgrade on all servers.
===Fatal error: Maximum execution time of 30 seconds exceeded...===
If your server uses a main language other than English, you may encounter a 'Fatal error: Maximum execution time of 30 seconds exceeded' when you try to upgrade it. You can increase max_execution_time = 160 on php.ini to allow the scripts enough time to process the language update. Otherwise, you can switch to English as the default language before doing the upgrade and back to your original language after a successful upgrade. See the forum discussion at https://moodle.org/mod/forum/discuss.php?d=119598.
==After upgrading==
{{Note|If BigBlueButtonBN was previously installed, because the recordings are processed asynchronously in the background, the data migration starts after the Moodle upgrade has been completed.

This means that in large deployments (with many recordings), the process may take some time (it can be hours) and therefore recordings may not be displayed immediately. But they are still there.}}
==Possible issues that may affect you in Moodle {{Version}}==

=== General ===

See the list of [https://tracker.moodle.org/issues/?jql=project%20%3D%20MDL%20AND%20resolution%20%3D%20Fixed%20AND%20fixVersion%20%3D%204.1%20AND%20labels%20%3D%20upgrade_notes upgrade_notes-labelled issues] and [https://tracker.moodle.org/issues/?jql=project%20%3D%20MDL%20AND%20resolution%20%3D%20Fixed%20AND%20fixVersion%20%3D%204.1%20AND%20labels%20%3D%20ui_change ui_change-labelled issues].

=== XMLRPC ===
* The installation of the '''XMLRPC PHP extension''' is not needed for Moodle 4.1 core anymore. All [[MNet]] features continue working exactly the same, but using a PHP library instead (see MDL-76055 for details).
* If you were using the '''webservice_xmlrpc''' plugin for integrations with other systems, be warned that it has been removed from core for Moodle 4.1 (see MDL-76052 for details). It's now available @ https://github.com/moodlehq/moodle-webservice_xmlrpc and has been also published in the [https://moodle.org/plugins/webservice_xmlrpc Plugins directory]. Note that, if you want to continue using this plugin, then you will need, '''before starting the upgrade process''', to:
*# Install the '''XMLRPC PHP extension''', the webservice requires it.
*# Install the '''webservice_xmlrpc plugin''', from the links in the previous paragraph, into the <tt>webservice/xmlrpc</tt> directory.
*# Then, and only then, start the upgrade process.

=== New plugins in Moodle {{Version}} ===
====BigBlueButton====
{{Note|For recordings to work properly, [https://docs.moodle.org/403/en/Cron Cron] Jobs must be enabled. Also, if you are using [https://github.com/blindsidenetworks/scalelite ScaleLite] for load balancing your BigBlueButton servers, make sure you are running the latest release of ScaleLite.}}
BigBlueButtonBN has been [https://moodle.org/plugins/mod_bigbluebuttonbn contributed plugin] for more than 10 years. It enables Moodle to interoperate with a BigBlueButton server and it is part of Moodle 4.0 as a core plugin. For more details see [https://docs.moodle.org/403/en/BigBlueButton BigBlueButton in Moodle 4.0]
When upgrading to Moodle 4.0, there are two possible scenarios.
===== BigBlueButtonBN was not installed =====
If the plugin was never installed, there are only two considerations to make.
* BigBlueButton is disabled by default. Administrators must enable it from Site administration > Plugins > Manage activities and then check the box to accept the data processing agreement.
* BigBlueButton is an external service. The plugin comes pre-configured with a Free Tier Hosting that comes with some restrictions.
===== BigBlueButtonBN was already installed =====
If the plugin was already installed, and the steps were followed correctly, the upgrade should be completed normally. But there are also some considerations to make.
* BigBlueButton may be disabled by default. If this is the case Administrators must enable it from Site administration > Plugins > Manage activities and then check the box to accept the data processing agreement.
* BigBlueButton is an external service. The plugin will only change the BigBlueButton credentials if the former Free Tier Hosting `https://test-install.blindsidenetworks.com/bigbluebutton/` was used. If it was not, then the existing service will still be the same.
===== General consideration =====
Regardless of the scenario, there is one general consideration

BigBlueButton is still the repository for recordings, but the metadata is now stored in Moodle, so instead of making a getRecording requests each time a BigBlueButton activity is displayed, the view is entirely populated with Moodle data. While this makes the code more efficient, it also means that every recording needs to be processed as part of the upgrade.
# For recordings to work properly, cron jobs must be enabled
# Since the recording are processed asynchronously in the background, the data migration starts after the Moodle upgrade has been completed. This means that in in large deployments (with many recordings), the recordings may take some time (it can be hours) to be processed and therefore to be displayed as part of the activities.

The details of the process can be checked in the cron job logs.

And remember that if the Plugin was not uninstalled, and the pre-existing rooms are there, the recordings are still referenced. Nothing is lost even if they are not shown immediately. They only need to be migrated.

Additionally, when using Scalelite as the Load Balancer for BigBlueButton, make sure the [https://github.com/blindsidenetworks/scalelite/releases/tag/v1.3.4 latest version] is deployed. With any other Load Balancer, make sure the BigBlueButton service updateRecordings is correctly implemented. Otherwise the migration will not be completed.
===Custom user tours===
If you have created any custom user tours where the URLs do not end in a % symbol (for example '/course/view.php'), these will no longer appear when viewing a page which has extra text at the end of the URL, such as /course/view.php?id=123. To make these tours work again, add a % to the end of the URL ('/course/view.php%'). The % symbol was always supposed to be necessary, but due to a bug in earlier versions, was previously not required.
===New capabilities in Moodle {{Version}}===
* mod/bigbluebuttonbn:addinstance
* mod/bigbluebuttonbn:addinstancewithmeeting
* mod/bigbluebuttonbn:addinstancewithrecording
* mod/bigbluebuttonbn:deleterecordings
* mod/bigbluebuttonbn:importrecordings
* mod/bigbluebuttonbn:join
* mod/bigbluebuttonbn:managerecordings
* mod/bigbluebuttonbn:protectrecordings
* mod/bigbluebuttonbn:publishrecordings
* mod/bigbluebuttonbn:unprotectrecordings
* mod/bigbluebuttonbn:unpublishrecordings
* mod/bigbluebuttonbn:view

* mod/quiz:emailnotifyattemptgraded

* moodle/question:commentall
* moodle/question:commentmine

* moodle/reportbuilder:edit
* moodle/reportbuilder:editall
* moodle/reportbuilder:scheduleviewas
* moodle/reportbuilder:view

* qbank/customfields:changelockedcustomfields
* qbank/customfields:configurecustomfields
* qbank/customfields:viewhiddencustomfields
=== Moodle 3.9, 3.10, 3.11 and 4.0 upgrading notes ===
Depending on which version you are upgrading from, please see the section 'Possible issues that may affect you' in the documentation:
* [https://docs.moodle.org/39/en/Upgrading Upgrading to Moodle 3.9]
* [https://docs.moodle.org/310/en/Upgrading Upgrading to Moodle 3.10]
* [https://docs.moodle.org/311/en/Upgrading Upgrading to Moodle 3.11]
* [https://docs.moodle.org/400/en/Upgrading Upgrading to Moodle 4.0]

==Any questions about the process?==
Please post in the [https://moodle.org/mod/forum/view.php?id=28 Installing and upgrading help forum] on moodle.org.
==See also==
* [[dev:Moodle {{Version}} release notes|Moodle {{Version}} release notes]]
* [https://moodle.org/mod/forum/discuss.php?d=393570 Problem accessing dropdown such as personal profile since 3.8 (20191118) update] forum discussion
[[es:Actualización de moodle]]
[[fr:Mise à jour]]
[[ja:Moodleをアップグレードする]]
[[de:Aktualisierung von Moodle]]

Upgrading

2022-11-15T14:22:33Z

Stronk7: Fixed a couple of links to point to 4.1 issues in the tracker

{{Installing Moodle}}
''This page explains in detail how to upgrade Moodle. For a summary of the process, see [[Upgrade overview]].''
==Check the requirements==
Before upgrading, check that your server meets all requirements for {{Version}} in ''Site administration > Server > [[Environment]]''.

See the [{{Release notes}} release notes] in the dev docs for both [{{Release notes}}#Server_requirements server] and [{{Release notes}}#Client_requirements client] software requirements.

Notes:
* You can only upgrade to Moodle {{Version}} from Moodle 3.9 or later. If upgrading from earlier versions, you must [https://docs.moodle.org/39/en/Upgrading_to_Moodle_3.9 upgrade to 3.9] as a first step.

==Before upgrading==
'''We advise that you test the upgrade first on a COPY of your production site, to make sure it works as you expect.'''

Consider setting the [[Upgrade key|upgrade key]] for your site.
== Backup important data ==
There are three areas that should be backed up before any upgrade:
#Moodle software (For example, everything in server/htdocs/moodle)
#Moodle uploaded files (For example, server/moodledata)
#Moodle database (For example, your Postgres or MySQL database dump)
See [[Site backup]] for more specific information.
== Check for plugin updates ==
If you have [[Automatic updates deployment]] enabled, you will be able to update installed plugins automatically during the upgrade. Just make sure you check for available updates (via the button for it) at the Plugins check screen.

If you are updating plugins manually, it is a good moment now to check in the [http://moodle.org/plugins Moodle Plugins directory] whether there is a {{Version}} version available for any plugins (including themes) that you have previously installed on your site. If so, download the plugin package. In the next step, you will copy it to the appropriate location in your Moodle code (see [[Installing plugins]]).

The upgrade of the plugin will then happen as part of the Moodle upgrade process.

If an out-of-date plugin causes your upgrade to fail, you can usually delete the plugin code rather than uninstalling it from within Moodle so that the data associated with it is not deleted.
==Put your site into maintenance mode==
Before you begin upgrading your site, you should put it into [[Maintenance_mode | maintenance mode]] to stop any non-admin users from logging in. Then you should wait for any currently running cron processes to complete before proceeding.
== Install the new Moodle software ==
You can download the latest release from [https://download.moodle.org/ Moodle downloads].
=== Standard install package ===
# Move your old Moodle software program files to another location. ''Do NOT copy new files over the old files.''
# Unzip or unpack the upgrade file so that all the new Moodle software program files are in the location the old files used to be in on the server. Moodle will adjust SQL and moodledata if it needs to in the upgrade.
# Copy your old [[Configuration file|config.php file]] back to the new Moodle directory.
# As mentioned above, if you had installed any plugins on your site you should add them to the new code tree (Moodle directory structure) now. It is important to check that you get the correct version for your new version of Moodle. Be particularly careful that you do not overwrite any code in the new version of Moodle and that you place the plugin folders in the correct directory (the same directory that they are in in the current installation.)
# Your moodledata folder should be located separately to your Moodle code folder and, as such, should not need anything done to it. Moodle 3.0 will throw a warning if it is located in a web accessible folder and the moodledata should never be located in the Moodle code folder. If you are moving your installation to a new server or new location on your server, then you will need to follow the [[Migration]] documents.
====Linux====
mv moodle moodle.backup
tar xvzf moodle-latest-{{Version}}.tgz
Next, copy across your config.php, any custom plugins, and your .htaccess file if you created one ('''check that custom plugins are the correct version for your new Moodle first'''):
cp moodle.backup/config.php moodle
cp -pr moodle.backup/theme/mytheme moodle/theme/mytheme
cp -pr moodle.backup/mod/mymod moodle/mod/mymod
Don't forget to make moodle/config.php (and the rest of the source code) readable by your www server. For maximum security the files should not be writeable by your server. This is especially important on a 'production' server open to the public internet.
chown -R root:root moodle (Linux debian - or even create a user especially for moodle. '''Don't''' use the web server user, e.g. www-data)
chmod -R 755 moodle
If you use cron, take care that cron.php is executeable and uses the correct php command:
chmod 740 admin/cli/cron.php (some configurations need chmod 750 or chmod 755)
copy the first line from cron.php (if it looks like '#!/usr/local/bin/php' or '#!/usr/local/bin/php5.3', no need to copy '<?php')
if necessary. However, for a simple upgrade, there should be no need to change anything with cron.
=== Using Git ===
You can use Git for updating or upgrading your Moodle. See [[Git for Administrators]] for details.
===Command line upgrade===
On Linux servers, Moodle {{Version}} supports running the [[CLI|upgrade from the command line]], rather than through a web browser. This is likely to be more reliable, particularly for large sites.
== Finishing the upgrade ==
The last step is to trigger the upgrade processes within Moodle.

If you put your site into Maintenance mode earlier; take it out now!

To do this just go to ''Site administration > Notifications''.

Moodle will automatically detect the new version and perform all the SQL database or file system upgrades that are necessary. If there is anything it can't do itself (very rare) then you will see messages telling you what you need to do.

Assuming all goes well (no error messages) then you can start using your new version of Moodle and enjoy the new features!

Note: If you are running multiple servers then you should purge all caches manually (via ''Site administration > Development > Purge all caches'') after completing the upgrade on all servers.
===Fatal error: Maximum execution time of 30 seconds exceeded...===
If your server uses a main language other than English, you may encounter a 'Fatal error: Maximum execution time of 30 seconds exceeded' when you try to upgrade it. You can increase max_execution_time = 160 on php.ini to allow the scripts enough time to process the language update. Otherwise, you can switch to English as the default language before doing the upgrade and back to your original language after a successful upgrade. See the forum discussion at https://moodle.org/mod/forum/discuss.php?d=119598.
==After upgrading==
{{Note|If BigBlueButtonBN was previously installed, because the recordings are processed asynchronously in the background, the data migration starts after the Moodle upgrade has been completed.

This means that in large deployments (with many recordings), the process may take some time (it can be hours) and therefore recordings may not be displayed immediately. But they are still there.}}
==Possible issues that may affect you in Moodle {{Version}}==

=== General ===

See the list of [https://tracker.moodle.org/issues/?jql=project%20%3D%20MDL%20AND%20resolution%20%3D%20Fixed%20AND%20fixVersion%20%3D%204.1%20AND%20labels%20%3D%20upgrade_notes upgrade_notes-labelled issues] and [https://tracker.moodle.org/issues/?jql=project%20%3D%20MDL%20AND%20resolution%20%3D%20Fixed%20AND%20fixVersion%20%3D%204.1%20AND%20labels%20%3D%20ui_change ui_change-labelled issues].

=== XMLRPC ===
* The installation of the '''XMLRPC PHP extension''' is not needed for Moodle 4.1 core anymore. All [[MNet]] features continue working exactly the same, but using a PHP library instead (see MDL-76055 for details).
* If you were using the '''webservice_xmlrpc''' plugin for integrations with other systems, be warned that it has been removed from core for Moodle 4.1 (see MDL-76052 for details). It's now available @ https://github.com/moodlehq/moodle-webservice_xmlrpc and has been also published in the [https://moodle.org/plugins/webservice_xmlrpc Plugins directory]. Note that, if you want to continue using this plugin, then you will need, '''before starting the upgrade process''', to:
*# Install the '''XMLRPC PHP extension''', the webservice requires it.
*# Install the '''webservice_xmlrpc plugin''', from the links in the previous paragraph, into the <tt>webservice/xmlrpc</tt> directory.
*# Then, and only then, start the upgrade process.

=== New plugins in Moodle {{Version}} ===
====BigBlueButton====
{{Note|For recordings to work properly, [https://docs.moodle.org/403/en/Cron Cron] Jobs must be enabled. Also, if you are using [https://github.com/blindsidenetworks/scalelite ScaleLite] for load balancing your BigBlueButton servers, make sure you are running the latest release of ScaleLite.}}
BigBlueButtonBN has been [https://moodle.org/plugins/mod_bigbluebuttonbn contributed plugin] for more than 10 years. It enables Moodle to interoperate with a BigBlueButton server and it is part of Moodle 4.0 as a core plugin. For more details see [https://docs.moodle.org/403/en/BigBlueButton BigBlueButton in Moodle 4.0]
When upgrading to Moodle 4.0, there are two possible scenarios.
===== BigBlueButtonBN was not installed =====
If the plugin was never installed, there are only two considerations to make.
* BigBlueButton is disabled by default. Administrators must enable it from Site administration > Plugins > Manage activities and then check the box to accept the data processing agreement.
* BigBlueButton is an external service. The plugin comes pre-configured with a Free Tier Hosting that comes with some restrictions.
===== BigBlueButtonBN was already installed =====
If the plugin was already installed, and the steps were followed correctly, the upgrade should be completed normally. But there are also some considerations to make.
* BigBlueButton may be disabled by default. If this is the case Administrators must enable it from Site administration > Plugins > Manage activities and then check the box to accept the data processing agreement.
* BigBlueButton is an external service. The plugin will only change the BigBlueButton credentials if the former Free Tier Hosting `https://test-install.blindsidenetworks.com/bigbluebutton/` was used. If it was not, then the existing service will still be the same.
===== General consideration =====
Regardless of the scenario, there is one general consideration

BigBlueButton is still the repository for recordings, but the metadata is now stored in Moodle, so instead of making a getRecording requests each time a BigBlueButton activity is displayed, the view is entirely populated with Moodle data. While this makes the code more efficient, it also means that every recording needs to be processed as part of the upgrade.
# For recordings to work properly, cron jobs must be enabled
# Since the recording are processed asynchronously in the background, the data migration starts after the Moodle upgrade has been completed. This means that in in large deployments (with many recordings), the recordings may take some time (it can be hours) to be processed and therefore to be displayed as part of the activities.

The details of the process can be checked in the cron job logs.

And remember that if the Plugin was not uninstalled, and the pre-existing rooms are there, the recordings are still referenced. Nothing is lost even if they are not shown immediately. They only need to be migrated.

Additionally, when using Scalelite as the Load Balancer for BigBlueButton, make sure the [https://github.com/blindsidenetworks/scalelite/releases/tag/v1.3.4 latest version] is deployed. With any other Load Balancer, make sure the BigBlueButton service updateRecordings is correctly implemented. Otherwise the migration will not be completed.
===Custom user tours===
If you have created any custom user tours where the URLs do not end in a % symbol (for example '/course/view.php'), these will no longer appear when viewing a page which has extra text at the end of the URL, such as /course/view.php?id=123. To make these tours work again, add a % to the end of the URL ('/course/view.php%'). The % symbol was always supposed to be necessary, but due to a bug in earlier versions, was previously not required.
===New capabilities in Moodle {{Version}}===
* mod/bigbluebuttonbn:addinstance
* mod/bigbluebuttonbn:addinstancewithmeeting
* mod/bigbluebuttonbn:addinstancewithrecording
* mod/bigbluebuttonbn:deleterecordings
* mod/bigbluebuttonbn:importrecordings
* mod/bigbluebuttonbn:join
* mod/bigbluebuttonbn:managerecordings
* mod/bigbluebuttonbn:protectrecordings
* mod/bigbluebuttonbn:publishrecordings
* mod/bigbluebuttonbn:unprotectrecordings
* mod/bigbluebuttonbn:unpublishrecordings
* mod/bigbluebuttonbn:view

* mod/quiz:emailnotifyattemptgraded

* moodle/question:commentall
* moodle/question:commentmine

* moodle/reportbuilder:edit
* moodle/reportbuilder:editall
* moodle/reportbuilder:scheduleviewas
* moodle/reportbuilder:view

* qbank/customfields:changelockedcustomfields
* qbank/customfields:configurecustomfields
* qbank/customfields:viewhiddencustomfields
=== Moodle 3.6, 3.7, 3.8, 3.9, 3.10 and 3.11 improvements ===
Depending on which version you are upgrading from, please see the section 'Possible issues that may affect you' in the documentation
* [https://docs.moodle.org/36/en/Upgrading Upgrading to Moodle 3.6]
* [https://docs.moodle.org/37/en/Upgrading Upgrading to Moodle 3.7]
* [https://docs.moodle.org/38/en/Upgrading Upgrading to Moodle 3.8]
* [https://docs.moodle.org/39/en/Upgrading Upgrading to Moodle 3.9]
* [https://docs.moodle.org/310/en/Upgrading Upgrading to Moodle 3.10]
* [https://docs.moodle.org/311/en/Upgrading Upgrading to Moodle 3.11]

==Any questions about the process?==
Please post in the [https://moodle.org/mod/forum/view.php?id=28 Installing and upgrading help forum] on moodle.org.
==See also==
* [[dev:Moodle {{Version}} release notes|Moodle {{Version}} release notes]]
* [https://moodle.org/mod/forum/discuss.php?d=393570 Problem accessing dropdown such as personal profile since 3.8 (20191118) update] forum discussion
[[es:Actualización de moodle]]
[[fr:Mise à jour]]
[[ja:Moodleをアップグレードする]]
[[de:Aktualisierung von Moodle]]

Upgrading

2022-11-15T14:21:19Z

Stronk7: Upgrade notes about XMLRPC added

{{Installing Moodle}}
''This page explains in detail how to upgrade Moodle. For a summary of the process, see [[Upgrade overview]].''
==Check the requirements==
Before upgrading, check that your server meets all requirements for {{Version}} in ''Site administration > Server > [[Environment]]''.

See the [{{Release notes}} release notes] in the dev docs for both [{{Release notes}}#Server_requirements server] and [{{Release notes}}#Client_requirements client] software requirements.

Notes:
* You can only upgrade to Moodle {{Version}} from Moodle 3.9 or later. If upgrading from earlier versions, you must [https://docs.moodle.org/39/en/Upgrading_to_Moodle_3.9 upgrade to 3.9] as a first step.

==Before upgrading==
'''We advise that you test the upgrade first on a COPY of your production site, to make sure it works as you expect.'''

Consider setting the [[Upgrade key|upgrade key]] for your site.
== Backup important data ==
There are three areas that should be backed up before any upgrade:
#Moodle software (For example, everything in server/htdocs/moodle)
#Moodle uploaded files (For example, server/moodledata)
#Moodle database (For example, your Postgres or MySQL database dump)
See [[Site backup]] for more specific information.
== Check for plugin updates ==
If you have [[Automatic updates deployment]] enabled, you will be able to update installed plugins automatically during the upgrade. Just make sure you check for available updates (via the button for it) at the Plugins check screen.

If you are updating plugins manually, it is a good moment now to check in the [http://moodle.org/plugins Moodle Plugins directory] whether there is a {{Version}} version available for any plugins (including themes) that you have previously installed on your site. If so, download the plugin package. In the next step, you will copy it to the appropriate location in your Moodle code (see [[Installing plugins]]).

The upgrade of the plugin will then happen as part of the Moodle upgrade process.

If an out-of-date plugin causes your upgrade to fail, you can usually delete the plugin code rather than uninstalling it from within Moodle so that the data associated with it is not deleted.
==Put your site into maintenance mode==
Before you begin upgrading your site, you should put it into [[Maintenance_mode | maintenance mode]] to stop any non-admin users from logging in. Then you should wait for any currently running cron processes to complete before proceeding.
== Install the new Moodle software ==
You can download the latest release from [https://download.moodle.org/ Moodle downloads].
=== Standard install package ===
# Move your old Moodle software program files to another location. ''Do NOT copy new files over the old files.''
# Unzip or unpack the upgrade file so that all the new Moodle software program files are in the location the old files used to be in on the server. Moodle will adjust SQL and moodledata if it needs to in the upgrade.
# Copy your old [[Configuration file|config.php file]] back to the new Moodle directory.
# As mentioned above, if you had installed any plugins on your site you should add them to the new code tree (Moodle directory structure) now. It is important to check that you get the correct version for your new version of Moodle. Be particularly careful that you do not overwrite any code in the new version of Moodle and that you place the plugin folders in the correct directory (the same directory that they are in in the current installation.)
# Your moodledata folder should be located separately to your Moodle code folder and, as such, should not need anything done to it. Moodle 3.0 will throw a warning if it is located in a web accessible folder and the moodledata should never be located in the Moodle code folder. If you are moving your installation to a new server or new location on your server, then you will need to follow the [[Migration]] documents.
====Linux====
mv moodle moodle.backup
tar xvzf moodle-latest-{{Version}}.tgz
Next, copy across your config.php, any custom plugins, and your .htaccess file if you created one ('''check that custom plugins are the correct version for your new Moodle first'''):
cp moodle.backup/config.php moodle
cp -pr moodle.backup/theme/mytheme moodle/theme/mytheme
cp -pr moodle.backup/mod/mymod moodle/mod/mymod
Don't forget to make moodle/config.php (and the rest of the source code) readable by your www server. For maximum security the files should not be writeable by your server. This is especially important on a 'production' server open to the public internet.
chown -R root:root moodle (Linux debian - or even create a user especially for moodle. '''Don't''' use the web server user, e.g. www-data)
chmod -R 755 moodle
If you use cron, take care that cron.php is executeable and uses the correct php command:
chmod 740 admin/cli/cron.php (some configurations need chmod 750 or chmod 755)
copy the first line from cron.php (if it looks like '#!/usr/local/bin/php' or '#!/usr/local/bin/php5.3', no need to copy '<?php')
if necessary. However, for a simple upgrade, there should be no need to change anything with cron.
=== Using Git ===
You can use Git for updating or upgrading your Moodle. See [[Git for Administrators]] for details.
===Command line upgrade===
On Linux servers, Moodle {{Version}} supports running the [[CLI|upgrade from the command line]], rather than through a web browser. This is likely to be more reliable, particularly for large sites.
== Finishing the upgrade ==
The last step is to trigger the upgrade processes within Moodle.

If you put your site into Maintenance mode earlier; take it out now!

To do this just go to ''Site administration > Notifications''.

Moodle will automatically detect the new version and perform all the SQL database or file system upgrades that are necessary. If there is anything it can't do itself (very rare) then you will see messages telling you what you need to do.

Assuming all goes well (no error messages) then you can start using your new version of Moodle and enjoy the new features!

Note: If you are running multiple servers then you should purge all caches manually (via ''Site administration > Development > Purge all caches'') after completing the upgrade on all servers.
===Fatal error: Maximum execution time of 30 seconds exceeded...===
If your server uses a main language other than English, you may encounter a 'Fatal error: Maximum execution time of 30 seconds exceeded' when you try to upgrade it. You can increase max_execution_time = 160 on php.ini to allow the scripts enough time to process the language update. Otherwise, you can switch to English as the default language before doing the upgrade and back to your original language after a successful upgrade. See the forum discussion at https://moodle.org/mod/forum/discuss.php?d=119598.
==After upgrading==
{{Note|If BigBlueButtonBN was previously installed, because the recordings are processed asynchronously in the background, the data migration starts after the Moodle upgrade has been completed.

This means that in large deployments (with many recordings), the process may take some time (it can be hours) and therefore recordings may not be displayed immediately. But they are still there.}}
==Possible issues that may affect you in Moodle {{Version}}==

=== XMLRPC ===
* The installation of the '''XMLRPC PHP extension''' is not needed for Moodle 4.1 core anymore. All [[MNet]] features continue working exactly the same, but using a PHP library instead (see MDL-76055 for details).
* If you were using the '''webservice_xmlrpc''' plugin for integrations with other systems, be warned that it has been removed from core for Moodle 4.1 (see MDL-76052 for details). It's now available @ https://github.com/moodlehq/moodle-webservice_xmlrpc and has been also published in the [https://moodle.org/plugins/webservice_xmlrpc Plugins directory]. Note that, if you want to continue using this plugin, then you will need, '''before starting the upgrade process''', to:
*# Install the '''XMLRPC PHP extension''', the webservice requires it.
*# Install the '''webservice_xmlrpc plugin''', from the links in the previous paragraph, into the <tt>webservice/xmlrpc</tt> directory.
*# Then, and only then, start the upgrade process.

See also the list of [https://tracker.moodle.org/issues/?jql=project%20%3D%20MDL%20AND%20resolution%20%3D%20Fixed%20AND%20fixVersion%20%3D%204.0%20AND%20labels%20%3D%20upgrade_notes upgrade_notes-labelled issues] and [https://tracker.moodle.org/issues/?jql=project%20%3D%20MDL%20AND%20resolution%20%3D%20Fixed%20AND%20fixVersion%20%3D%204.0%20AND%20labels%20%3D%20ui_change ui_change-labelled issues].

=== New plugins in Moodle {{Version}} ===
====BigBlueButton====
{{Note|For recordings to work properly, [https://docs.moodle.org/403/en/Cron Cron] Jobs must be enabled. Also, if you are using [https://github.com/blindsidenetworks/scalelite ScaleLite] for load balancing your BigBlueButton servers, make sure you are running the latest release of ScaleLite.}}
BigBlueButtonBN has been [https://moodle.org/plugins/mod_bigbluebuttonbn contributed plugin] for more than 10 years. It enables Moodle to interoperate with a BigBlueButton server and it is part of Moodle 4.0 as a core plugin. For more details see [https://docs.moodle.org/403/en/BigBlueButton BigBlueButton in Moodle 4.0]
When upgrading to Moodle 4.0, there are two possible scenarios.
===== BigBlueButtonBN was not installed =====
If the plugin was never installed, there are only two considerations to make.
* BigBlueButton is disabled by default. Administrators must enable it from Site administration > Plugins > Manage activities and then check the box to accept the data processing agreement.
* BigBlueButton is an external service. The plugin comes pre-configured with a Free Tier Hosting that comes with some restrictions.
===== BigBlueButtonBN was already installed =====
If the plugin was already installed, and the steps were followed correctly, the upgrade should be completed normally. But there are also some considerations to make.
* BigBlueButton may be disabled by default. If this is the case Administrators must enable it from Site administration > Plugins > Manage activities and then check the box to accept the data processing agreement.
* BigBlueButton is an external service. The plugin will only change the BigBlueButton credentials if the former Free Tier Hosting `https://test-install.blindsidenetworks.com/bigbluebutton/` was used. If it was not, then the existing service will still be the same.
===== General consideration =====
Regardless of the scenario, there is one general consideration

BigBlueButton is still the repository for recordings, but the metadata is now stored in Moodle, so instead of making a getRecording requests each time a BigBlueButton activity is displayed, the view is entirely populated with Moodle data. While this makes the code more efficient, it also means that every recording needs to be processed as part of the upgrade.
# For recordings to work properly, cron jobs must be enabled
# Since the recording are processed asynchronously in the background, the data migration starts after the Moodle upgrade has been completed. This means that in in large deployments (with many recordings), the recordings may take some time (it can be hours) to be processed and therefore to be displayed as part of the activities.

The details of the process can be checked in the cron job logs.

And remember that if the Plugin was not uninstalled, and the pre-existing rooms are there, the recordings are still referenced. Nothing is lost even if they are not shown immediately. They only need to be migrated.

Additionally, when using Scalelite as the Load Balancer for BigBlueButton, make sure the [https://github.com/blindsidenetworks/scalelite/releases/tag/v1.3.4 latest version] is deployed. With any other Load Balancer, make sure the BigBlueButton service updateRecordings is correctly implemented. Otherwise the migration will not be completed.
===Custom user tours===
If you have created any custom user tours where the URLs do not end in a % symbol (for example '/course/view.php'), these will no longer appear when viewing a page which has extra text at the end of the URL, such as /course/view.php?id=123. To make these tours work again, add a % to the end of the URL ('/course/view.php%'). The % symbol was always supposed to be necessary, but due to a bug in earlier versions, was previously not required.
===New capabilities in Moodle {{Version}}===
* mod/bigbluebuttonbn:addinstance
* mod/bigbluebuttonbn:addinstancewithmeeting
* mod/bigbluebuttonbn:addinstancewithrecording
* mod/bigbluebuttonbn:deleterecordings
* mod/bigbluebuttonbn:importrecordings
* mod/bigbluebuttonbn:join
* mod/bigbluebuttonbn:managerecordings
* mod/bigbluebuttonbn:protectrecordings
* mod/bigbluebuttonbn:publishrecordings
* mod/bigbluebuttonbn:unprotectrecordings
* mod/bigbluebuttonbn:unpublishrecordings
* mod/bigbluebuttonbn:view

* mod/quiz:emailnotifyattemptgraded

* moodle/question:commentall
* moodle/question:commentmine

* moodle/reportbuilder:edit
* moodle/reportbuilder:editall
* moodle/reportbuilder:scheduleviewas
* moodle/reportbuilder:view

* qbank/customfields:changelockedcustomfields
* qbank/customfields:configurecustomfields
* qbank/customfields:viewhiddencustomfields
=== Moodle 3.6, 3.7, 3.8, 3.9, 3.10 and 3.11 improvements ===
Depending on which version you are upgrading from, please see the section 'Possible issues that may affect you' in the documentation
* [https://docs.moodle.org/36/en/Upgrading Upgrading to Moodle 3.6]
* [https://docs.moodle.org/37/en/Upgrading Upgrading to Moodle 3.7]
* [https://docs.moodle.org/38/en/Upgrading Upgrading to Moodle 3.8]
* [https://docs.moodle.org/39/en/Upgrading Upgrading to Moodle 3.9]
* [https://docs.moodle.org/310/en/Upgrading Upgrading to Moodle 3.10]
* [https://docs.moodle.org/311/en/Upgrading Upgrading to Moodle 3.11]

==Any questions about the process?==
Please post in the [https://moodle.org/mod/forum/view.php?id=28 Installing and upgrading help forum] on moodle.org.
==See also==
* [[dev:Moodle {{Version}} release notes|Moodle {{Version}} release notes]]
* [https://moodle.org/mod/forum/discuss.php?d=393570 Problem accessing dropdown such as personal profile since 3.8 (20191118) update] forum discussion
[[es:Actualización de moodle]]
[[fr:Mise à jour]]
[[ja:Moodleをアップグレードする]]
[[de:Aktualisierung von Moodle]]

Upgrading

2022-11-15T13:54:19Z

Stronk7: Moodle 4.1 requires Moodle 3.9 to upgrade

{{Installing Moodle}}
''This page explains in detail how to upgrade Moodle. For a summary of the process, see [[Upgrade overview]].''
==Check the requirements==
Before upgrading, check that your server meets all requirements for {{Version}} in ''Site administration > Server > [[Environment]]''.

See the [{{Release notes}} release notes] in the dev docs for both [{{Release notes}}#Server_requirements server] and [{{Release notes}}#Client_requirements client] software requirements.

Notes:
* You can only upgrade to Moodle {{Version}} from Moodle 3.9 or later. If upgrading from earlier versions, you must [https://docs.moodle.org/39/en/Upgrading_to_Moodle_3.9 upgrade to 3.9] as a first step.

==Before upgrading==
'''We advise that you test the upgrade first on a COPY of your production site, to make sure it works as you expect.'''

Consider setting the [[Upgrade key|upgrade key]] for your site.
== Backup important data ==
There are three areas that should be backed up before any upgrade:
#Moodle software (For example, everything in server/htdocs/moodle)
#Moodle uploaded files (For example, server/moodledata)
#Moodle database (For example, your Postgres or MySQL database dump)
See [[Site backup]] for more specific information.
== Check for plugin updates ==
If you have [[Automatic updates deployment]] enabled, you will be able to update installed plugins automatically during the upgrade. Just make sure you check for available updates (via the button for it) at the Plugins check screen.

If you are updating plugins manually, it is a good moment now to check in the [http://moodle.org/plugins Moodle Plugins directory] whether there is a {{Version}} version available for any plugins (including themes) that you have previously installed on your site. If so, download the plugin package. In the next step, you will copy it to the appropriate location in your Moodle code (see [[Installing plugins]]).

The upgrade of the plugin will then happen as part of the Moodle upgrade process.

If an out-of-date plugin causes your upgrade to fail, you can usually delete the plugin code rather than uninstalling it from within Moodle so that the data associated with it is not deleted.
==Put your site into maintenance mode==
Before you begin upgrading your site, you should put it into [[Maintenance_mode | maintenance mode]] to stop any non-admin users from logging in. Then you should wait for any currently running cron processes to complete before proceeding.
== Install the new Moodle software ==
You can download the latest release from [https://download.moodle.org/ Moodle downloads].
=== Standard install package ===
# Move your old Moodle software program files to another location. ''Do NOT copy new files over the old files.''
# Unzip or unpack the upgrade file so that all the new Moodle software program files are in the location the old files used to be in on the server. Moodle will adjust SQL and moodledata if it needs to in the upgrade.
# Copy your old [[Configuration file|config.php file]] back to the new Moodle directory.
# As mentioned above, if you had installed any plugins on your site you should add them to the new code tree (Moodle directory structure) now. It is important to check that you get the correct version for your new version of Moodle. Be particularly careful that you do not overwrite any code in the new version of Moodle and that you place the plugin folders in the correct directory (the same directory that they are in in the current installation.)
# Your moodledata folder should be located separately to your Moodle code folder and, as such, should not need anything done to it. Moodle 3.0 will throw a warning if it is located in a web accessible folder and the moodledata should never be located in the Moodle code folder. If you are moving your installation to a new server or new location on your server, then you will need to follow the [[Migration]] documents.
====Linux====
mv moodle moodle.backup
tar xvzf moodle-latest-{{Version}}.tgz
Next, copy across your config.php, any custom plugins, and your .htaccess file if you created one ('''check that custom plugins are the correct version for your new Moodle first'''):
cp moodle.backup/config.php moodle
cp -pr moodle.backup/theme/mytheme moodle/theme/mytheme
cp -pr moodle.backup/mod/mymod moodle/mod/mymod
Don't forget to make moodle/config.php (and the rest of the source code) readable by your www server. For maximum security the files should not be writeable by your server. This is especially important on a 'production' server open to the public internet.
chown -R root:root moodle (Linux debian - or even create a user especially for moodle. '''Don't''' use the web server user, e.g. www-data)
chmod -R 755 moodle
If you use cron, take care that cron.php is executeable and uses the correct php command:
chmod 740 admin/cli/cron.php (some configurations need chmod 750 or chmod 755)
copy the first line from cron.php (if it looks like '#!/usr/local/bin/php' or '#!/usr/local/bin/php5.3', no need to copy '<?php')
if necessary. However, for a simple upgrade, there should be no need to change anything with cron.
=== Using Git ===
You can use Git for updating or upgrading your Moodle. See [[Git for Administrators]] for details.
===Command line upgrade===
On Linux servers, Moodle {{Version}} supports running the [[CLI|upgrade from the command line]], rather than through a web browser. This is likely to be more reliable, particularly for large sites.
== Finishing the upgrade ==
The last step is to trigger the upgrade processes within Moodle.

If you put your site into Maintenance mode earlier; take it out now!

To do this just go to ''Site administration > Notifications''.

Moodle will automatically detect the new version and perform all the SQL database or file system upgrades that are necessary. If there is anything it can't do itself (very rare) then you will see messages telling you what you need to do.

Assuming all goes well (no error messages) then you can start using your new version of Moodle and enjoy the new features!

Note: If you are running multiple servers then you should purge all caches manually (via ''Site administration > Development > Purge all caches'') after completing the upgrade on all servers.
===Fatal error: Maximum execution time of 30 seconds exceeded...===
If your server uses a main language other than English, you may encounter a 'Fatal error: Maximum execution time of 30 seconds exceeded' when you try to upgrade it. You can increase max_execution_time = 160 on php.ini to allow the scripts enough time to process the language update. Otherwise, you can switch to English as the default language before doing the upgrade and back to your original language after a successful upgrade. See the forum discussion at https://moodle.org/mod/forum/discuss.php?d=119598.
==After upgrading==
{{Note|If BigBlueButtonBN was previously installed, because the recordings are processed asynchronously in the background, the data migration starts after the Moodle upgrade has been completed.

This means that in large deployments (with many recordings), the process may take some time (it can be hours) and therefore recordings may not be displayed immediately. But they are still there.}}
==Possible issues that may affect you in Moodle {{Version}}==
''Please add items here...''
* [[:dev:Core plugins review for Moodle 4.0]]
* [[:dev:Add a block cleanup]]

See also the list of [https://tracker.moodle.org/issues/?jql=project%20%3D%20MDL%20AND%20resolution%20%3D%20Fixed%20AND%20fixVersion%20%3D%204.0%20AND%20labels%20%3D%20upgrade_notes upgrade_notes-labelled issues] and [https://tracker.moodle.org/issues/?jql=project%20%3D%20MDL%20AND%20resolution%20%3D%20Fixed%20AND%20fixVersion%20%3D%204.0%20AND%20labels%20%3D%20ui_change ui_change-labelled issues].

=== New plugins in Moodle {{Version}} ===
====BigBlueButton====
{{Note|For recordings to work properly, [https://docs.moodle.org/403/en/Cron Cron] Jobs must be enabled. Also, if you are using [https://github.com/blindsidenetworks/scalelite ScaleLite] for load balancing your BigBlueButton servers, make sure you are running the latest release of ScaleLite.}}
BigBlueButtonBN has been [https://moodle.org/plugins/mod_bigbluebuttonbn contributed plugin] for more than 10 years. It enables Moodle to interoperate with a BigBlueButton server and it is part of Moodle 4.0 as a core plugin. For more details see [https://docs.moodle.org/403/en/BigBlueButton BigBlueButton in Moodle 4.0]
When upgrading to Moodle 4.0, there are two possible scenarios.
===== BigBlueButtonBN was not installed =====
If the plugin was never installed, there are only two considerations to make.
* BigBlueButton is disabled by default. Administrators must enable it from Site administration > Plugins > Manage activities and then check the box to accept the data processing agreement.
* BigBlueButton is an external service. The plugin comes pre-configured with a Free Tier Hosting that comes with some restrictions.
===== BigBlueButtonBN was already installed =====
If the plugin was already installed, and the steps were followed correctly, the upgrade should be completed normally. But there are also some considerations to make.
* BigBlueButton may be disabled by default. If this is the case Administrators must enable it from Site administration > Plugins > Manage activities and then check the box to accept the data processing agreement.
* BigBlueButton is an external service. The plugin will only change the BigBlueButton credentials if the former Free Tier Hosting `https://test-install.blindsidenetworks.com/bigbluebutton/` was used. If it was not, then the existing service will still be the same.
===== General consideration =====
Regardless of the scenario, there is one general consideration

BigBlueButton is still the repository for recordings, but the metadata is now stored in Moodle, so instead of making a getRecording requests each time a BigBlueButton activity is displayed, the view is entirely populated with Moodle data. While this makes the code more efficient, it also means that every recording needs to be processed as part of the upgrade.
# For recordings to work properly, cron jobs must be enabled
# Since the recording are processed asynchronously in the background, the data migration starts after the Moodle upgrade has been completed. This means that in in large deployments (with many recordings), the recordings may take some time (it can be hours) to be processed and therefore to be displayed as part of the activities.

The details of the process can be checked in the cron job logs.

And remember that if the Plugin was not uninstalled, and the pre-existing rooms are there, the recordings are still referenced. Nothing is lost even if they are not shown immediately. They only need to be migrated.

Additionally, when using Scalelite as the Load Balancer for BigBlueButton, make sure the [https://github.com/blindsidenetworks/scalelite/releases/tag/v1.3.4 latest version] is deployed. With any other Load Balancer, make sure the BigBlueButton service updateRecordings is correctly implemented. Otherwise the migration will not be completed.
===Custom user tours===
If you have created any custom user tours where the URLs do not end in a % symbol (for example '/course/view.php'), these will no longer appear when viewing a page which has extra text at the end of the URL, such as /course/view.php?id=123. To make these tours work again, add a % to the end of the URL ('/course/view.php%'). The % symbol was always supposed to be necessary, but due to a bug in earlier versions, was previously not required.
===New capabilities in Moodle {{Version}}===
* mod/bigbluebuttonbn:addinstance
* mod/bigbluebuttonbn:addinstancewithmeeting
* mod/bigbluebuttonbn:addinstancewithrecording
* mod/bigbluebuttonbn:deleterecordings
* mod/bigbluebuttonbn:importrecordings
* mod/bigbluebuttonbn:join
* mod/bigbluebuttonbn:managerecordings
* mod/bigbluebuttonbn:protectrecordings
* mod/bigbluebuttonbn:publishrecordings
* mod/bigbluebuttonbn:unprotectrecordings
* mod/bigbluebuttonbn:unpublishrecordings
* mod/bigbluebuttonbn:view

* mod/quiz:emailnotifyattemptgraded

* moodle/question:commentall
* moodle/question:commentmine

* moodle/reportbuilder:edit
* moodle/reportbuilder:editall
* moodle/reportbuilder:scheduleviewas
* moodle/reportbuilder:view

* qbank/customfields:changelockedcustomfields
* qbank/customfields:configurecustomfields
* qbank/customfields:viewhiddencustomfields
=== Moodle 3.6, 3.7, 3.8, 3.9, 3.10 and 3.11 improvements ===
Depending on which version you are upgrading from, please see the section 'Possible issues that may affect you' in the documentation
* [https://docs.moodle.org/36/en/Upgrading Upgrading to Moodle 3.6]
* [https://docs.moodle.org/37/en/Upgrading Upgrading to Moodle 3.7]
* [https://docs.moodle.org/38/en/Upgrading Upgrading to Moodle 3.8]
* [https://docs.moodle.org/39/en/Upgrading Upgrading to Moodle 3.9]
* [https://docs.moodle.org/310/en/Upgrading Upgrading to Moodle 3.10]
* [https://docs.moodle.org/311/en/Upgrading Upgrading to Moodle 3.11]

==Any questions about the process?==
Please post in the [https://moodle.org/mod/forum/view.php?id=28 Installing and upgrading help forum] on moodle.org.
==See also==
* [[dev:Moodle {{Version}} release notes|Moodle {{Version}} release notes]]
* [https://moodle.org/mod/forum/discuss.php?d=393570 Problem accessing dropdown such as personal profile since 3.8 (20191118) update] forum discussion
[[es:Actualización de moodle]]
[[fr:Mise à jour]]
[[ja:Moodleをアップグレードする]]
[[de:Aktualisierung von Moodle]]

Analytics settings

2021-11-11T18:16:26Z

Stronk7: tidy up some code and information making reference to mlbackend versions

{{Analytics}}
The Moodle learning analytics system requires some initial configuration before it can be used. You can access ''Analytics settings'' from ''Site administration > Analytics > Analytics settings''.

== Site information ==

Site information will be used to help learning analytics models take characteristics of the institution into account. This information is also reported as part of site data collection when you register your site. This will allow HQ to understand which areas in learning analytics are seeing the most use and prioritize development resources appropriately.

== Configure learning analytics settings ==

Analytics may be disabled from Site administration / Advanced features

They may then be configured from Site administration / Analytics.

=== Predictions processor ===

[[Image:analytics01_predictions_processor34.png|frame|center|Predictions processor selection]]

Prediction processors are the machine learning backends that process the datasets generated from the calculated indicators and targets and return predictions. Moodle core includes 2 prediction processors:

==== PHP predictions processor ====

The PHP processor is the default. There are no other system requirements to use this processor.

==== Python predictions processor ====

The Python processor is more powerful and it generates [https://www.tensorflow.org/get_started/summaries_and_tensorboard graphs that explain the model performance]. It requires setting up extra tools: Python itself (https://wiki.python.org/moin/BeginnersGuide/Download) and the moodlemlbackend python package. The package can be installed in the web server (in all the nodes if in a clustered environment) or in a separate server.

===== Versions =====

* Moodle 3.8 and up uses package 2.3.* (minimum 2.3.1)
* Moodle 3.9.11 and up uses package 2.6.* (minimum 2.6.4)
* Moodle 3.10.8 and up uses package 2.6.* (minimum 2.6.4)
* Moodle 3.11.4 and up uses package 2.6.* (minimum 2.6.4)
* Moodle 4.0 and up uses package 3.0.* (minimum 3.0.2)

===== Installed in the web server =====

The latest version of the [https://pypi.org/project/moodlemlbackend/ packages for '''Moodle 3.8''' and up] are compatible with '''Python 3.4, 3.5, 3.6 and 3.7'''. Note that the package should be available for both the Command Line Interface (CLI) user and the user who runs the web server (e.g. www-data).

# If necessary, install Python 3 (and pip for Python 3)
# Ensure that you use Python 3 to install the moodlemlbackend package (for VERSION, see the previous section):

sudo -H python3 -m pip install "moodlemlbackend==VERSION"
# You must also enter the path to the Python 3 executable in Site administration -> Server -> System paths:
[[File:path_to_python_3.png|frame|center|Enter system path for Python 3]]

===== Installed in a separate server =====

To install the python package in a separate server instead of installing it on the web server/s have some advantages:
* Keeps the python ML backend as an external service
* To keep a separated control of the resources the web server/s dedicate to serving Moodle and the resources dedicated to the python ML backend
* You can reuse the same ML server for multiple Moodle sites. Easier to setup and maintain than to install/upgrade the python package in all nodes in the cluster
* You can install the package as a new docker container in your dockerized environment
* You can serve the ML backend from AWS through the API gateway and AWS lambda, storing the trained model files in S3

On the other hand, it is expected that there can be some added latency in connecting to the python ML backend server.

The python backend is exposed as a Flask application. The Flask application is part of the official 'moodlemlbackend' Python package and its FLASK_APP script is 'webapp', in the root of the package. You are free to use the setup that better suits your existing infrastructure.

====== New server in your infrastructure ======

The python ML backend is exposed as a Flask application, which uses a WSGI server (https://wsgi.readthedocs.io/en/latest/what.html) to be exposed to the www. The official documentation on how to deploy a Flask app can be found in https://flask.palletsprojects.com/en/1.0.x/tutorial/deploy/.

* Use MOODLE_MLBACKEND_PYTHON_USERS environment var to set a list of users and password (comma-separated). The value is 'default:sshhhh' (user: default, password: sshhhh).
* Set MOODLE_MLBACKEND_PYTHON_DIR to the path you want to use to store the data generated by the package

====== Docker ======

https://hub.docker.com/r/moodlehq/moodle-mlbackend-python is the official moodle-mlbackend-python docker image. We use it internally at Moodle HQ for internal testing and you can use it as well. You may want more control over the image, if that is the case https://github.com/moodlehq/moodle-docker-mlbackend-python/blob/master/Dockerfile can serve as an example of what is needed to get the python moodlemlbackend package working.

* Use MOODLE_MLBACKEND_PYTHON_USERS environment var to set a list of users and passwords (comma-separated). The value is 'default:sshhhh' (user: default, password: sshhhh).

To run the docker container locally you can execute (For <tt>VERSION</tt>, see the Versions section above):

<syntaxhighlight lang="bash">
docker pull moodlehq/moodle-mlbackend-python:VERSION-python3.7.5
docker run -d -p 5000:5000 --name=mlbackendpython --rm --add-host=mlbackendpython:0.0.0.0 moodlehq/moodle-mlbackend-python:VERSION-python3.7.5
</syntaxhighlight >
'''Note''' that you need to add <tt>--network=moodledocker_default</tt> if your are using moodle-docker and you want this container to be visible from the web server.

Then add this to your config.php file:

<syntaxhighlight lang="php">
$CFG->pathtopython = 'python';
define('TEST_MLBACKEND_PYTHON_HOST', 'localhost'); // Change to "mlbackendpython" if your are using moodle-docker.
define('TEST_MLBACKEND_PYTHON_PORT', 5000);
define('TEST_MLBACKEND_PYTHON_USERNAME', 'default');
define('TEST_MLBACKEND_PYTHON_PASSWORD', 'sshhhh');
</syntaxhighlight>

To check if it works, this command should not Skip any test:

<syntaxhighlight lang="bash">
vendor/bin/phpunit analytics/tests/prediction_test.php --verbose
</syntaxhighlight>

====== AWS serverless service ======

You can serve the Flask application as a serverless application using the AWS API gateway and AWS lambda. The easiest way to do it is using Zappa https://github.com/Miserlou/Zappa to deploy the Flask application contained in the python ML package.

* Use MOODLE_MLBACKEND_PYTHON_USERS environment var to set a list of users and password (comma-separated). The value is 'default:sshhhh' (user: default, password: sshhhh).
* Set MOODLE_MLBACKEND_PYTHON_DIR to the path you want to use to store the data generated by the package
* Set these environment variables below to setup the S3 access:
** MOODLE_MLBACKEND_PYTHON_S3_BUCKET_NAME to the bucket name
**AWS_ACCESS_KEY_ID as usual
** AWS_SECRET_ACCESS_KEY as usual

Once this has been done, you can select the Python prediction processor as the default or for an individual model:
[[File:python_backend.png|frame|center|Predictions processor default]]

[[File:python_backend_at_model.png|frame|center|Predictions processor selection for an individual model]]

=== Log store ===
From Moodle version 2.7 and up, the “Standard logstore” is the default. If for some reason you also have data in the older “legacy logs,” you can enable the Moodle Learning Analytics system to access them instead.

=== Analysis intervals ===

Analysis intervals determine how often insights will be generated, and how much information to use for each calculation. Using proportional analysis intervals allows courses of different lengths to be used to train a single model.

Several analysis intervals are available for models in the system. In this setting, the analysis intervals that will be used to evaluate models are defined, e.g. so the best analysis interval identified by the evaluation process can be selected for the model. This setting does not restrict the analysis intervals that can be used for specific models.

[[Image:06_timesplitting.png|frame|center|Analysis intervals]]

Each analysis interval divides the course duration into segments. At the end of each defined segment, the predictions engine will run and generate insights. It is recommended that you only enable the analysis intervals you are interested in using; the evaluation process will iterate through all enabled analysis intervals, so the more analysis intervals enabled, the slower the evaluation process will be.

=== Models output directory ===

[[Image:03_models_output_directory.png|frame|center|Models output directory]]

This setting allows you to define a directory where machine learning backends data is stored. Be sure this directory exists and is writable by the web server. This setting can be used by Moodle sites with multiple frontend nodes (a cluster) to specify a shared directory across nodes. This directory can be used by machine learning backends to store trained algorithms (its internal variables weights and stuff like that) to use them later to get predictions. Moodle cron lock will prevent multiple executions of the analytics tasks that train machine learning algorithms and get predictions from them.

== Scheduled tasks ==

Most analytics API processes are executed through [[Scheduled_tasks|scheduled tasks]]. These processes usually read the activity log table and can require some time to finish. You can find ''Train models'' and ''Predict models'' scheduled tasks listed in ''Administration > Site administration > Server > Scheduled tasks.'' It is recommended to edit the tasks schedule so they run nightly.

==Capabilities==

There are two analytics capabilities:

* [[Capabilities/moodle/analytics:managemodels|Manage models]] - allowed for the default role of manager only
* [[Capabilities/moodle/analytics:listinsights|List insights]] - allowed for the default roles of manager, teacher and non-editing teacher

To receive notifications and view insights, a user must have the list insights capability within the context used as the "Analysable" for the model. For example, the [[Students at risk of dropping out]] model operates within the context of a course. Insights will be generated for each enrolment within any course matching the criteria of the model (courses with a start date in the past and an end date in the future, with at least one teacher and student), and these insights will be sent to anyone with the list insights capability in that course.

Some models (e.g. the ''No teaching'' model) generate insights at the Site level. To receive insights from these models, the user must have a role assignment at the System level which includes the list insights capability.

'''Note''': Site administrators do '''not''' automatically receive insight notifications, though they can choose to view details of any insight notifications on the system. To enable site administrators to receive notifications of insights, assign an additional role that includes the list insights capability to the site administrator at the system level.

[[Category:Analytics]]

[[es:Configuraciones de analítica]]
[[de:Analytics-Einstellungen]]

Analytics settings

2021-11-11T17:46:37Z

Stronk7: Specify the versions to be used by different Moodle branches

{{Analytics}}
The Moodle learning analytics system requires some initial configuration before it can be used. You can access ''Analytics settings'' from ''Site administration > Analytics > Analytics settings''.

== Site information ==

Site information will be used to help learning analytics models take characteristics of the institution into account. This information is also reported as part of site data collection when you register your site. This will allow HQ to understand which areas in learning analytics are seeing the most use and prioritize development resources appropriately.

== Configure learning analytics settings ==

Analytics may be disabled from Site administration / Advanced features

They may then be configured from Site administration / Analytics.

=== Predictions processor ===

[[Image:analytics01_predictions_processor34.png|frame|center|Predictions processor selection]]

Prediction processors are the machine learning backends that process the datasets generated from the calculated indicators and targets and return predictions. Moodle core includes 2 prediction processors:

==== PHP predictions processor ====

The PHP processor is the default. There are no other system requirements to use this processor.

==== Python predictions processor ====

The Python processor is more powerful and it generates [https://www.tensorflow.org/get_started/summaries_and_tensorboard graphs that explain the model performance]. It requires setting up extra tools: Python itself (https://wiki.python.org/moin/BeginnersGuide/Download) and the moodlemlbackend python package. The package can be installed in the web server (in all the nodes if in a clustered environment) or in a separate server.

===== Versions =====

* Moodle 3.8 and up uses package 2.3.* (minimum 2.3.1)
* Moodle 3.9.11 and up uses package 2.6.* (minimum 2.6.4)
* Moodle 3.10.8 and up uses package 2.6.* (minimum 2.6.4)
* Moodle 3.11.4 and up uses package 2.6.* (minimum 2.6.4)
* Moodle 4.0 and up uses package 3.0.* (minimum 3.0.2)

===== Installed in the web server =====

The latest version of the [https://pypi.org/project/moodlemlbackend/ packages for '''Moodle 3.8''' and up] are compatible with '''Python 3.4, 3.5, 3.6 and 3.7'''. Note that the package should be available for both the Command Line Interface (CLI) user and the user who runs the web server (e.g. www-data).

# If necessary, install Python 3 (and pip for Python 3)
# Ensure that you use Python 3 to install the moodlemlbackend package (for VERSION, see the previous section):

sudo -H python3 -m pip install "moodlemlbackend==VERSION"
# You must also enter the path to the Python 3 executable in Site administration -> Server -> System paths:
[[File:path_to_python_3.png|frame|center|Enter system path for Python 3]]

===== Installed in a separate server =====

To install the python package in a separate server instead of installing it on the web server/s have some advantages:
* Keeps the python ML backend as an external service
* To keep a separated control of the resources the web server/s dedicate to serving Moodle and the resources dedicated to the python ML backend
* You can reuse the same ML server for multiple Moodle sites. Easier to setup and maintain than to install/upgrade the python package in all nodes in the cluster
* You can install the package as a new docker container in your dockerized environment
* You can serve the ML backend from AWS through the API gateway and AWS lambda, storing the trained model files in S3

On the other hand, it is expected that there can be some added latency in connecting to the python ML backend server.

The python backend is exposed as a Flask application. The Flask application is part of the official 'moodlemlbackend' Python package and its FLASK_APP script is 'webapp', in the root of the package. You are free to use the setup that better suits your existing infrastructure.

====== New server in your infrastructure ======

The python ML backend is exposed as a Flask application, which uses a WSGI server (https://wsgi.readthedocs.io/en/latest/what.html) to be exposed to the www. The official documentation on how to deploy a Flask app can be found in https://flask.palletsprojects.com/en/1.0.x/tutorial/deploy/.

* Use MOODLE_MLBACKEND_PYTHON_USERS environment var to set a list of users and password (comma-separated). The value is 'default:sshhhh' (user: default, password: sshhhh).
* Set MOODLE_MLBACKEND_PYTHON_DIR to the path you want to use to store the data generated by the package

====== Docker ======

https://hub.docker.com/r/moodlehq/moodle-mlbackend-python is the official moodle-mlbackend-python docker image. We use it internally at Moodle HQ for internal testing and you can use it as well. You may want more control over the image, if that is the case https://github.com/moodlehq/moodle-docker-mlbackend-python/blob/master/Dockerfile can serve as an example of what is needed to get the python moodlemlbackend package working.

* Use MOODLE_MLBACKEND_PYTHON_USERS environment var to set a list of users and passwords (comma-separated). The value is 'default:sshhhh' (user: default, password: sshhhh).

To run the docker container locally you can execute:

<code bash>
docker pull moodlehq/moodle-mlbackend-python:2.4.0-python3.7.5
# Note that you need to add --network=moodledocker_default if your are using moodle-docker and you want this container to be visible from the web server.
docker run -d -p 5000:5000 --name=mlbackendpython --rm --add-host=mlbackendpython:0.0.0.0 moodlehq/moodle-mlbackend-python:2.4.0-python3.7.5
</code>

Then add this to your config.php file:

<code php>
$CFG->pathtopython = 'python';
define('TEST_MLBACKEND_PYTHON_HOST', 'localhost'); // Change to "mlbackendpython" if your are using moodle-docker.
define('TEST_MLBACKEND_PYTHON_PORT', 5000);
define('TEST_MLBACKEND_PYTHON_USERNAME', 'default');
define('TEST_MLBACKEND_PYTHON_PASSWORD', 'sshhhh');
</code>

To check if it works, this command should not Skip any test:

<code bash>
vendor/bin/phpunit analytics/tests/prediction_test.php --verbose
</code>

====== AWS serverless service ======

You can serve the Flask application as a serverless application using the AWS API gateway and AWS lambda. The easiest way to do it is using Zappa https://github.com/Miserlou/Zappa to deploy the Flask application contained in the python ML package.

* Use MOODLE_MLBACKEND_PYTHON_USERS environment var to set a list of users and password (comma-separated). The value is 'default:sshhhh' (user: default, password: sshhhh).
* Set MOODLE_MLBACKEND_PYTHON_DIR to the path you want to use to store the data generated by the package
* Set these environment variables below to setup the S3 access:
** MOODLE_MLBACKEND_PYTHON_S3_BUCKET_NAME to the bucket name
**AWS_ACCESS_KEY_ID as usual
** AWS_SECRET_ACCESS_KEY as usual

Once this has been done, you can select the Python prediction processor as the default or for an individual model:
[[File:python_backend.png|frame|center|Predictions processor default]]

[[File:python_backend_at_model.png|frame|center|Predictions processor selection for an individual model]]

=== Log store ===
From Moodle version 2.7 and up, the “Standard logstore” is the default. If for some reason you also have data in the older “legacy logs,” you can enable the Moodle Learning Analytics system to access them instead.

=== Analysis intervals ===

Analysis intervals determine how often insights will be generated, and how much information to use for each calculation. Using proportional analysis intervals allows courses of different lengths to be used to train a single model.

Several analysis intervals are available for models in the system. In this setting, the analysis intervals that will be used to evaluate models are defined, e.g. so the best analysis interval identified by the evaluation process can be selected for the model. This setting does not restrict the analysis intervals that can be used for specific models.

[[Image:06_timesplitting.png|frame|center|Analysis intervals]]

Each analysis interval divides the course duration into segments. At the end of each defined segment, the predictions engine will run and generate insights. It is recommended that you only enable the analysis intervals you are interested in using; the evaluation process will iterate through all enabled analysis intervals, so the more analysis intervals enabled, the slower the evaluation process will be.

=== Models output directory ===

[[Image:03_models_output_directory.png|frame|center|Models output directory]]

This setting allows you to define a directory where machine learning backends data is stored. Be sure this directory exists and is writable by the web server. This setting can be used by Moodle sites with multiple frontend nodes (a cluster) to specify a shared directory across nodes. This directory can be used by machine learning backends to store trained algorithms (its internal variables weights and stuff like that) to use them later to get predictions. Moodle cron lock will prevent multiple executions of the analytics tasks that train machine learning algorithms and get predictions from them.

== Scheduled tasks ==

Most analytics API processes are executed through [[Scheduled_tasks|scheduled tasks]]. These processes usually read the activity log table and can require some time to finish. You can find ''Train models'' and ''Predict models'' scheduled tasks listed in ''Administration > Site administration > Server > Scheduled tasks.'' It is recommended to edit the tasks schedule so they run nightly.

==Capabilities==

There are two analytics capabilities:

* [[Capabilities/moodle/analytics:managemodels|Manage models]] - allowed for the default role of manager only
* [[Capabilities/moodle/analytics:listinsights|List insights]] - allowed for the default roles of manager, teacher and non-editing teacher

To receive notifications and view insights, a user must have the list insights capability within the context used as the "Analysable" for the model. For example, the [[Students at risk of dropping out]] model operates within the context of a course. Insights will be generated for each enrolment within any course matching the criteria of the model (courses with a start date in the past and an end date in the future, with at least one teacher and student), and these insights will be sent to anyone with the list insights capability in that course.

Some models (e.g. the ''No teaching'' model) generate insights at the Site level. To receive insights from these models, the user must have a role assignment at the System level which includes the list insights capability.

'''Note''': Site administrators do '''not''' automatically receive insight notifications, though they can choose to view details of any insight notifications on the system. To enable site administrators to receive notifications of insights, assign an additional role that includes the list insights capability to the site administrator at the system level.

[[Category:Analytics]]

[[es:Configuraciones de analítica]]
[[de:Analytics-Einstellungen]]

Configuration file

2021-09-09T14:22:48Z

Stronk7: fix filter_tex plugin name

{{Installing Moodle}}
The name for Moodle's configuration file is config.php. The file is located in the moodle directory. It is not included in the Moodle download packages and is created by the installation process from the template file config-dist.php (which is included in Moodle packages).

==config-dist.php==
Although the installation process creates the config.php file for you, there may be times when you want to do this yourself. A sample config file, called config-dist.php, is shipped with Moodle.

To get started simply copy config-dist.php to config.php, then edit config.php with you favourite editor. The file is very well commented. The important options (which you must supply) are all nearer the top. Other less common options are further down.

==Setting $CFG->wwwroot correctly==
This setting must be a fixed URL (a string constant) that points to your site. Do not try to set this with any PHP code that can generate a variable URL. This is not supported, can cause strange problems and will stop command line scripts working completely. If your site is accessed from different IP addresses this should be done with a split DNS, see [[Masquerading]]

If you change your site from http to https, you '''MUST''' update this setting. If you don’t, you will have problems - for example (but not limited to) css scripts won’t load properly and you will also experience problems with logging in to your site. Also see [[Transitioning_to_HTTPS]]

==Enabling password salting==

See [[Password salting]].

==Including passwords in backups==

Hashed user passwords are no longer saved in backup files containing user data.

If you really need passwords to be saved (in the rare case of restoring a [[Backup of user data|backup with user data]] to a different site), the following line may be added to config.php:

$CFG->includeuserpasswordsinbackup = true;

Note regarding restoring Moodle 2.5 backups to sites with old PHP versions:

Because bcrypt is not supported in PHP versions below 5.3.7, course backups made using the $CFG->includeuserpasswordsinbackup setting on a site using PHP version 5.3.7+ that are subsequently restored to a site with PHP version < 5.3.7 will require a password reset.

==Changing default block layout for new courses==

See [[Block layout]].

==Adding extra theme directory location==
It is possible to add an extra themes directory stored outside of $CFG->dirroot. This local directory does not have to be accessible from internet. Themes placed in the directory specified by these variables will then be available for selection using the theme selector.

For example, should you wish to place extra themes in a subdirectory called 'my_moodle_themes', your config.php might look like this:
<pre>
$CFG->wwwroot = 'http://my.moodle.site.edu';
$CFG->dirroot = '/var/www/my.moodle.site.edu/public_html';
$CFG->themedir = $CFG->dirroot . '/my_moodle_themes';
</pre>

==Disabling update notifications==

See [[Notifications]].

==Enabling debugging==

See [[Debugging]].

==Forcing the value of admin settings==

As explained in config-dist.php, it is possible to specify normal admin settings here, the point is that they can not be changed through the standard admin settings pages any more. Just set the value in config.php like:

<syntaxhighlight lang="php">
$CFG->showuseridentity = 'email,idnumber,username';
$CFG->preventexecpath = true;
$CFG->pathtodu = "/usr/bin/du";
$CFG->pathtodot = "/usr/bin/dot";
$CFG->pathtogs = "/usr/bin/gs";
</syntaxhighlight>

Configuration for plugins can also be forced by the syntax is different, eg continuing the example above for security to always hard coded paths to all executable files:

<syntaxhighlight lang="php">
$CFG->forced_plugin_settings['filter_tex']['pathconvert'] = '/usr/bin/convert';
$CFG->forced_plugin_settings['filter_tex']['pathdvips'] = '/usr/bin/dvips';
$CFG->forced_plugin_settings['filter_tex']['pathdvisvgm'] = '/usr/bin/dvisvgm';
$CFG->forced_plugin_settings['filter_tex']['pathlatex'] = '/usr/bin/latex';
</syntaxhighlight>

==See also==

* Using Moodle [http://moodle.org/mod/forum/discuss.php?d=137889 Moodle Salting] forum discussion

[[de:Konfigurationsdatei]]
[[es:config.php]]
[[fr:Fichier de configuration]]
[[ja:設定ファイル]]

Administration via command line

2021-06-02T22:06:12Z

Stronk7: Content only applicable to previous version: Removing this from stable versions following the removal of code for 4.0 - MDL-71476

{{Installing Moodle}}
==Running CLI scripts==
If you have shell access to your web server, you may find various CLI (command line interface) scripts useful during Moodle administration. Core admin CLI tools are located in the <code>admin/cli/*</code> folder. Other plugins provide their CLI functionality via scripts in their own cli folder. For example, the enrol_db sync script is located in <code>enrol/db/cli/</code>.

To avoid problems with access control, you should run them as the owner of the web server process. It is especially important for CLI installation and upgrade as they create new files in moodledata directory and the web server has to have write access to them. In Linux distributions, the user that runs the web server is usually apache or wwrun or httpd or something similar. As a root, you will probably want to execute Moodle CLI scripts like this:

$ cd /path/to/your/moodle/dir
$ sudo -u apache /usr/bin/php admin/cli/somescript.php --params

Most of the scripts accept common --help (or -h) parameter to display the full usage information, for example:

$ sudo -u apache /usr/bin/php admin/cli/install.php --help

{{Note|These scripts are supposed to be run under the identity of the web server user. Examples on this page use the <tt>apache</tt> user for illustration. The particular value depends on your OS distribution and local set-up. Typical values may be <tt>apache</tt>, <tt>www-data</tt> or <tt>httpd</tt>.}}

== Upgrading ==

Moodle can be upgraded from the command line. As with the installation script, there is either interactive or non-interactive mode of the upgrade. The script itself does not put the site into the maintenance mode, you have to do it on your own. Also, the script does not backup any data (if you read this page, you probably have some own scripts to backup your moodledata and the database, right?)

$ sudo -u apache /usr/bin/php admin/cli/upgrade.php

Upgrading via command line is a very comfortable way of Moodle upgrade if you use Git checkout of the Moodle source code (see [[Git for Administrators]]). See the following procedure how to upgrade your site within several seconds to the most recent version while preserving your eventual local customizations tracked in git repository:

$ cd /var/www/sites/moodle/htdocs/
$ sudo -u apache /usr/bin/php admin/cli/maintenance.php --enable
$ git pull
$ sudo -u apache /usr/bin/php admin/cli/upgrade.php
$ sudo -u apache /usr/bin/php admin/cli/maintenance.php --disable

== Installation ==

There are two modes of installing Moodle from the command line. In interactive mode, the install script asks you for all data needed to properly set up new Moodle site. In non-interactive mode, you must provide all required data as the script parameters and then the new site is installed silently. The parameters can be passed in the interactive mode, too. The provided values are then used as the default values during the interactive session.

$ sudo -u apache /usr/bin/php admin/cli/install.php --lang=cs

If your arguments contain some specials characters for Linux based systems, don't forget to ''escape'' them with a backslash. For example, if you want to create an admin with ''pa$sword'' as password you should wrote ''pa\$sword'' instead!

If required, the database install may be skipped, with just config.php populated.

$ sudo -u apache /usr/bin/php admin/cli/install.php --skip-database

== Maintenance mode ==

To switch your site into the maintenance mode via CLI, you can use

$ sudo -u apache /usr/bin/php admin/cli/maintenance.php --enable

To turn maintenance mode off, execute the same script with the --disable parameter:

$ sudo -u apache /usr/bin/php admin/cli/maintenance.php --disable

If you don't want to enable maintenance mode immediately, but show a countdown to your users, execute the same script with the --enablelater parameter and the number of minutes which the countdown should run:

$ sudo -u apache /usr/bin/php admin/cli/maintenance.php --enablelater=10

This script will also create and remove the climaintenance.html file for "Offline" mode.

== Offline mode ==

In some situations, you may want to switch your Moodle site into offline mode so that it is not accessible via the web but you can not stop the web server completely (typically because there are other web pages and applications running there). If a file called <code>climaintenance.html</code> exists in the root folder of moodledata directory, Moodle will automatically display the contents of that file instead of any other page.

$ cd /var/www/sites/moodle/moodledata/
$ echo '<h1>Sorry, maintenance in progress</h1>' > climaintenance.html

You can prepare a nice formatted HTML page to inform your users about the server being down and keep in the moodledata directory under a name like <code>climaintenance.off</code> and rename it to the <code>climaintenance.html</code> if needed.

== Custom site defaults ==

During the install and upgrade via CLI, Moodle sets the administration variables to the default values. You can use different defaults. See MDL-17850 for details. Shortly, all you need to do is to add a file <code>local/defaults.php</code> into your Moodle installation. The format of the file is like

<code php>
<?php
$defaults['pluginname']['settingname'] = 'settingvalue'; // for plugins
$defaults['moodle']['settingname'] = 'settingvalue'; // for core settings
</code>

These defaults are used during install, upgrade and are also displayed as defaults on Site administration pages.

== Reset user password ==

If you happen to forget your admin password (or you want to set a password for any other user on the site), you can use reset_password.php script. The script sets the correctly salted password for the given user.

$ sudo -u apache /usr/bin/php admin/cli/reset_password.php

==Converting InnoDB tables to Barracuda==

Sites using MySQL with database tables using Antelope as the file format are recommended to convert the tables to the Barracuda file format.

This is because tables using Antelope as the file format cannot handle more than 10 text columns. This file formats only supports ''compact'' and ''redundant'' row formats for backward compatibility reasons. This may cause a problem on larger sites when restoring a course, in which case the following error will be displayed:

Row size too large (>8126). Changing some columns to TEXT or BLOB or using ROW_FORMAT=DYNAMIC or ROW_FORMAT=COMPRESSED may help.

Barracuda is the newest innoDB file format. In addition to supporting ''compact'' and ''redundant'' row formats, Barracuda also supports ''compressed'' and ''dynamic'' row formats.

However, converting tables to Barracuda is only recommended, and not required, since not all MySQL users are affected. (It may only be a problem for larger sites.)

===Tool for converting tables===

A command line tool is included in Moodle for converting tables to Barracuda.

To view tables requiring conversion, use the list option:

$ php admin/cli/mysql_compressed_rows.php --list

Here is an example output:

mdl_data Compact (needs fixing)
mdl_data_fields Compact (needs fixing)
mdl_enrol_paypal Compact (needs fixing)

To proceed with the conversion, run the command using the fix option:

$ php admin/cli/mysql_compressed_rows.php --fix

Successful table conversion will be reported in the output, for example:

mdl_data ... Compressed
mdl_data_fields ... Compressed
mdl_enrol_paypal ... Compressed

Please note that the commands must be executed on your moodle directory. Once tables are fixed, the warning message will no longer be displayed.

For further information on InnoDB file formats see the [http://dev.mysql.com/doc/innodb/1.1/en/glossary.html#glos_antelope MySQL InnoDB glossary - Antelope] and the [http://dev.mysql.com/doc/innodb/1.1/en/glossary.html#glos_barracuda MySQL InnoDB glossary - Barracuda].

If you get errors due to having insufficient privileges to run these commands (this is quite likely) then the easiest solution is to generate the required SQL commands using,

$ php admin/cli/mysql_compressed_rows.php --showsql

You can then copy the generated SQL into your mysql client running as the 'root' user.

==Converting to the new character set and collation==

$ php admin/cli/mysql_collation.php --collation=utf8mb4_unicode_ci

== Running cron via command line ==

In versions 1.x, you could execute admin/cron.php either from command line or via the web. Since Moodle 2.0, only admin/cli/cron.php script can be run via command line.

== Scheduled tasks ==

Scheduled tasks are automatically run by the cron script, but the specific tasks which run on each cron iteration are determined by the scheduled tasks configuration. It is possible to override the scheduled tasks configuration and run a single scheduled task immediately using the admin/tool/task/cli/schedule_task.php script.

This script accepts the following arguments:

--list - list all the known scheduled tasks. The tasks are listed by the class name used to run the task. This class name is required as the argument to the next option in order to run a specific task immediately.

--execute=<task> - Runs a single scheduled task immediately - regardless of scheduling settings. This will even run disabled tasks. Tasks will still use locking to prevent concurrent execution of the same task - even on clusters. The format of the <task> argument must be the same as returned by the --list option above.

--showsql - Shows sql queries before they are execute

--showdebugging - Shows developer debugging info

'''Note:''' You must escape the "\" with an extra \ when using the --execute command. Take the following for example:

<pre>php admin/tool/task/cli/schedule_task.php --list</pre>

will return something like:

<pre>
== List of scheduled tasks (http://yourserver.com/moodle) ==
\enrol_imsenterprise\task\cron_task 10 * * * * * ASAP
\logstore_legacy\task\cleanup_task * 5 * * * * ASAP
\logstore_standard\task\cleanup_task * 4 * * * * Wednesday, November 12, 2014, 4:35 AM
\mod_forum\task\cron_task * * * * * * ASAP
\core\task\automated_backup_task 50 * * * * * ASAP

...
</pre>

To run the first task in that list, you would execute

php admin/tool/task/cli/schedule_task.php --execute='\enrol_imsenterprise\task\cron_task'

Be aware of the single quotes. Without them, you would need to use double backlashes to avoid escaping by the shell.

==Database transfer==

A command line script for [[Database transfer]] may be found in ''admin/tool/dbtransfer/cli/migrate.php''.

==Purge caches==

You can purge caches using this script:

php admin/cli/purge_caches.php

==Kill all sessions==
If needed for administrative reasons, you can kill all user sessions using this script:

php admin/cli/kill_all_sessions.php

As a result, all users will be logged out from Moodle.

==Backup and restore of large courses==

See Backup via CLI in [[Course backup]] and Restore via CLI in [[Course restore]] (new in 3.10 onwards).

==Fix course / module sequences==

In rare cases (such as after upgrading from a very old version of Moodle), the course / section / module sequence data can be out of sync. This can cause various problems for affected courses, such as sections not appearing, backups failing, pages not displaying etc. There is a specific check to check for errors caused by this problem, and to fix the data in the database if they are found. To run this script please use the command below:

php admin/cli/fix_course_sequence.php -c=* --fix

This will check every course in Moodle and report which ones had errors and were fixed.

==Fix orphaned question categories==

When a quiz is created, a new question category for the quiz is automatically created. In versions of Moodle prior to 2.9.1, if the quiz is deleted, the question category and any questions in the category remain in database. These orphaned question categories may be fixed by running the admin/cli/fix_orphaned_question_categories.php script with the --fix option.

==Search and replace text==

This script can be used to search and replace text throughout the whole database. Use carefully and backup first always. More info in [[Search and replace tool]].

php admin/tool/replace/cli/replace.php --search=//oldsitehost --replace=//newsitehost

==Build theme CSS cache==

If Moodle is not running in theme designer mode it will keep a copy of the compiled CSS on local disk and serve that to the browser when it requests a page. If there isn't a copy on local disk then a copy will be built the first time a page within Moodle is requested.

With this script you can pre-compile the cached CSS files for themes within Moodle to avoid having a user wait for the theme to compile during the first page request.

php admin/cli/build_theme_css.php --themes=boost

==Get and set configuration values==

Displays the current value of the given setting, or set the given setting to the specified value.

$ php admin/cli/cfg.php [--component=<componentname>] [--json] [--shell-arg]
$ php admin/cli/cfg.php --name=<configname> [--component=<componentname>] [--shell-arg] [--no-eol]
$ php admin/cli/cfg.php --name=<configname> [--component=<componentname>] --set=<value>
$ php admin/cli/cfg.php --name=<configname> [--component=<componentname>] --unset
$ php admin/cli/cfg.php [--help|-h]

Examples:
$ php admin/cli/cfg.php --name=langmenu
will display the value of ''Display language menu'' in ''Site administration > Language > Language settings'' (0 for ''No'' or 1 for ''Yes'').
$ php cfg.php --name=maxsizetodownload --component=folder
will display the value of ''Maximum folder download size (MB)'' accessible from ''Site administration > Plugins > Activity modules > Folder''.
$ php admin/cli/cfg.php --name=langmenu --set=0
will disable the ''Language menu''.

==See also==

* MDL-35736 - Manage plugins via command line
* MDL-36237 - Resort course list via CLI
* [http://moosh-online.com/ MOOSH] - MOOdle SHell. It is a commandline tool that will allow you to perform most common Moodle tasks.

[[fr:Administration en ligne de commande]]
[[de:Administration über Kommandozeile]]
[[es:Administración por línea de comando]]
[[it:Amministrazione via linea di comando]]
[[ja:コマンドライン経由の管理]]

Upgrading

2021-05-17T00:09:47Z

Stronk7: Moodle 3.11 required Moodle 3.6

Environment - max input vars

2021-05-06T17:02:43Z

Stronk7: Add environment category

The PHP setting '''max_input_vars''' determines how many input variables may be accepted (limit is applied to $_GET, $_POST and $_COOKIE superglobal separately). If there are more input variables than specified by this directive, an E_WARNING is issued, and further input variables are truncated from the request.

There are a lot of big or potentially big forms in Moodle, such as:
* Site administration tree search
* Editing roles
* Grading courses with big number of participants
* Large quizzes and quiz settings

The default value for max_input_vars in PHP is '''1000''', this is not enough for many cases.

If you are using PHP 7 the recommended value for the '''max_input_vars''' in Moodle is '''5000''' but you can still use Moodle with the lower value. Moodle code has a workaround that allows to submit the forms even with bigger limit however this workaround is not perfect. It is much better to increase the setting.

If you are using PHP 8 the minimum value of 5000 '''is required'''. By default PHP 8 sets to display startup errors (see [[https://php.watch/versions/8.0/startup-errors-enabled]]). This means that the warning about exceeding max_input_vars appears before the workaround even applied.

To change max_input_vars you can either set it in php.ini or modify it in runtime, for example for Apache you can create '''.htaccess''' file:
<code>
php_value max_input_vars 5000
</code>

[[Category:Environment|PHP]]

[[es:admin/environment/custom check/max input vars]]

Environment - PHP extension sodium

2021-05-06T12:25:04Z

Stronk7:

{{Environment}}

The php-sodium extension provides strong encryption capabilities in an easy and consistent way.

Note that, for sites not having the extension installed, a php-openssl based solution, considered suboptimal, is used, and this fallback will stop working in a few versions (Moodle 4.2). See MDL-71421 for more details.

Hence, it's highly recommended to start using php-sodium.

Please see [https://www.php.net/manual/book.sodium.php https://www.php.net/manual/book.sodium.php]

Please see [https://py-ipv8.readthedocs.io/en/latest/preliminaries/install_libsodium/]

[[Category:Environment|PHP]]

[[es:admin/environment/php extension/sodium]]

Environment - PHP extension sodium

2021-05-06T12:24:39Z

Stronk7: Some notes about php-sodium and current php-openssl fallback

{{Environment}}

The php-sodium extension provides strong encryption capabilities in an easy and consistent way.

Note that, for sites not having the extension installed, a php-openssl based solution, considered suboptimal, is used, and this fallback will stop working in a few versions (Moodle 4.2).

Hence, it's highly recommended to start using php-sodium.

Please see [https://www.php.net/manual/book.sodium.php https://www.php.net/manual/book.sodium.php]

Please see [https://py-ipv8.readthedocs.io/en/latest/preliminaries/install_libsodium/]

[[Category:Environment|PHP]]

[[es:admin/environment/php extension/sodium]]

Upgrading

2018-12-03T00:49:37Z

Stronk7: reorganize the section to avoid duplicating incomplete information. Always refer to the release notes for server and client requirements.

{{Installing Moodle}}
''This page explains in detail how to upgrade Moodle. For a summary of the process, see [[Upgrade overview]].''

==Check the requirements==

Before upgrading, check that your server meets all requirements for {{Version}} in ''Administration > Site administration > Server > [[Environment]]''.

See the [{{Release notes}} release notes] in the dev docs for both [{{Release notes}}#Server_requirements server] and [{{Release notes}}#Client_requirements client] software requirements.

Notes:

* You can only upgrade to Moodle {{Version}} from Moodle 3.1 or later. If upgrading from earlier versions, you must [https://docs.moodle.org/31/en/Upgrading_to_Moodle_3.1 upgrade to 3.1] as a first step.

==Before upgrading==

'''We advise that you test the upgrade first on a COPY of your production site, to make sure it works as you expect.'''

Consider setting the [[Upgrade key|upgrade key]] for your site.

== Backup important data ==

There are three areas that should be backed up before any upgrade:
#Moodle software (For example, everything in server/htdocs/moodle)
#Moodle uploaded files (For example, server/moodledata)
#Moodle database (For example, your Postgres or MySQL database dump)

See [[Site backup]] for more specific information.

== Check for plugin updates ==

If you have [[Automatic updates deployment]] enabled, you will be able to update installed plugins automatically during the upgrade. Just make sure you check for available updates (via the button for it) at the Plugins check screen.

If you are updating plugins manually, it is a good moment now to check in the [http://moodle.org/plugins Moodle Plugins directory] whether there is a {{Version}} version available for any plugins (including themes) that you have previously installed on your site. If so, download the plugin package. In the next step, you will copy it to the appropriate location in your Moodle code (see [[Installing plugins]]).

The upgrade of the plugin will then happen as part of the Moodle upgrade process.

If an out-of-date plugin causes your upgrade to fail, you can usually delete the plugin code rather than uninstalling it from within Moodle so that the data associated with it is not deleted.

==Put your site into maintenance mode==
Before you begin upgrading your site, you should put it into [[Maintenance_mode | maintenance mode]] to stop any non-admin users from logging in. Then you should wait for any currently running cron processes to complete before proceeding.

== Install the new Moodle software ==
You can fetch the current version of the software through

wget http://sourceforge.net/projects/moodle/files/Moodle/stable{{Version2}}/moodle-latest-{{Version2}}.tgz

=== Standard install package ===

# Move your old Moodle software program files to another location. ''Do NOT copy new files over the old files.''
# Unzip or unpack the upgrade file so that all the new Moodle software program files are in the location the old files used to be in on the server. Moodle will adjust SQL and moodledata if it needs to in the upgrade.
# Copy your old [[Configuration file|config.php file]] back to the new Moodle directory.
# As mentioned above, if you had installed any plugins on your site you should add them to the new code tree (Moodle directory structure) now. It is important to check that you get the correct version for your new version of Moodle. Be particularly careful that you do not overwrite any code in the new version of Moodle and that you place the plugin folders in the correct directory (the same directory that they are in in the current installation.)
# Your moodledata folder should be located separately to your Moodle code folder and, as such, should not need anything done to it. Moodle 3.0 will throw a warning if it is located in a web accessible folder and the moodledata should never be located in the Moodle code folder. If you are moving your installation to a new server or new location on your server, then you will need to follow the Migration documents.

====Linux====
mv moodle moodle.backup
tar xvzf moodle-{{Version}}.tgz

Next, copy across your config.php, any custom plugins, and your .htaccess file if you created one ('''check that custom plugins are the correct version for your new Moodle first'''):

cp moodle.backup/config.php moodle
cp -pr moodle.backup/theme/mytheme moodle/theme/mytheme
cp -pr moodle.backup/mod/mymod moodle/mod/mymod

Don't forget to make moodle/config.php (and the rest of the source code) readable by your www server. Ideally the files should not be writeable by your server.

chown -R www-data:www-data moodle (Linux debian - change to appropriate user and group for your OS version)
chmod -R 755 moodle

If you use cron, take care that cron.php is executeable and uses the correct php command:
chmod 740 admin/cli/cron.php (some configurations need chmod 750 or chmod 755)
copy the first line from cron.php (if it looks like '#!/usr/local/bin/php' or '#!/usr/local/bin/php5.3', no need to copy '<?php')
if necessary. However, for a simple upgrade, there should be no need to change anything with cron.

=== Using Git ===

You can use Git for updating or upgrading your Moodle. See [[Git for Administrators]] for details.

===Command line upgrade===

On Linux servers, Moodle {{Version}} supports running the [[CLI|upgrade from the command line]], rather than through a web browser. This is likely to be more reliable, particularly for large sites.

== Finishing the upgrade ==

The last step is to trigger the upgrade processes within Moodle.

If you put your site into Maintenance mode earlier; take it out now!

To do this just go to ''Administration > Site administration > Notifications''.

Moodle will automatically detect the new version and perform all the SQL database or file system upgrades that are necessary. If there is anything it can't do itself (very rare) then you will see messages telling you what you need to do.

Assuming all goes well (no error messages) then you can start using your new version of Moodle and enjoy the new features!

Note: If you are running multiple servers then you should purge all caches manually (via ''Administration > Site administration > Development > Purge all caches'') after completing the upgrade on all servers.

===Fatal error: Maximum execution time of 30 seconds exceeded...===

If your server uses a main language other than English, you may encounter a 'Fatal error: Maximum execution time of 30 seconds exceeded' when you try to upgrade it. You can increase max_execution_time = 160 on php.ini to allow the scripts enough time to process the language update. Otherwise, you can switch to English as the default language before doing the upgrade and back to your original language after a succcessful upgrade. See the forum discussion at https://moodle.org/mod/forum/discuss.php?d=119598.

==After upgrading==

The config.php file from your installation should work fine but if you take a look at config-dist.php that came with Moodle 3.0 there are more/different options available (e.g. database drivers and settings). It's a good idea to map your old config.php settings to a new one based on the 3.0 config-dist.php.

===Cron===

Cron has received a major update (MDL-25499) and now has support for both scheduled and ad hoc tasks.

The benefits of these changes are:
* The schedule for every task can be configured by the admin
* Tasks can run in parallel
* Cron processes use locking to prevent the same task running at the same time by different processes
* Clusters with multiple identical application nodes are supported, you can run cron on all of them

A result of this is that cron can be run much more often, which means (for example) forum posts can be sent out sooner. To take advantage of the new cron system it is now strongly recommended that administrators increase the frequency that cron is run to at least ''once per minute''.

You also may need to modify any automated scripts you have that are parsing the output from cron. It is no longer possible to simply monitor the output of cron for the string "Cron script completed correctly" (if that is what you were doing). An alternative is to monitor the output for the string "task failed:". If you detect that a task is failing, [[Cron#Debugging_Scheduled_Tasks|here]] are some tips for debugging the failure.

Before the upgrade, there may have been a cron task that was failing, which was preventing the rest of cron from being executed. A failure in any single task will no longer prevent the rest of the Moodle cron tasks from executing, so you may uncover previously masked bugs. It is a good idea to closely monitor the output from cron after the upgrade.

===Assignments===

The old assignment (2.2) module has been removed from core and has been replaced by a stub to support transparently remapping URLs and restoring course backups from the old module to the new one.

If you are still using the old assignment (2.2) module, after upgrading to Moodle 3.0 all assignment (2.2) activities will be hidden. You need to run the [[Assignment upgrade tool]] to un-hide the activities.

If you really, really need to keep using the old assignment (2.2) module, you should update the code to Moodle 3.0, and then replace the "mod/assignment" folder with the one from https://github.com/moodlehq/moodle-mod_assignment/releases before completing the upgrade.

==Possible issues that may affect you in Moodle {{Version}}==

* To use 'Run now' links in [[Scheduled tasks]], you need to set 'Path to PHP CLI' (pathtophp) in Site administration > Server > System paths.

''Items to be added...''

See also the list of [https://tracker.moodle.org/issues/?jql=project%20%3D%20mdl%20AND%20resolution%20%3D%20fixed%20AND%20fixVersion%20in%20(%223.6%22)%20AND%20labels%20%3D%20upgrade_notes upgrade_notes-labelled issues] and [https://tracker.moodle.org/issues/?jql=project%20%3D%20mdl%20AND%20resolution%20%3D%20fixed%20AND%20fixVersion%20in%20(%223.6%22)%20AND%20labels%20%3D%20ui_change%20 ui_change-labelled issues].

=== Moodle 3.1, 3.2, 3.3, 3.4 and 3.5 improvements ===

Depending on which version you are upgrading from, please see the section 'Possible issues that may affect you' in the documentation

* [https://docs.moodle.org/31/en/Upgrading Upgrading to Moodle 3.1]
* [https://docs.moodle.org/32/en/Upgrading Upgrading to Moodle 3.2]
* [https://docs.moodle.org/33/en/Upgrading Upgrading to Moodle 3.3]
* [https://docs.moodle.org/34/en/Upgrading Upgrading to Moodle 3.4]
* [https://docs.moodle.org/35/en/Upgrading Upgrading to Moodle 3.5]

==See also==

* [[Installation]]
* Using Moodle [http://moodle.org/mod/forum/view.php?id=28 Installation help forum]
* [[dev:Moodle {{Version}} release notes|Moodle {{Version}} release notes]]

[[es:Actualización de moodle]]
[[fr:Mise à jour]]
[[ja:Moodleをアップグレードする]]
[[de:Aktualisierung von Moodle]]

Upgrading

2018-11-25T12:28:24Z

Stronk7: Add a note about PHP 7.3 being work in progress.

{{Installing Moodle}}
''This page explains in detail how to upgrade Moodle. For a summary of the process, see [[Upgrade overview]].''

==Check the requirements==

Check that your server meets all requirements for {{Version}} in ''Administration > Site administration > Server > [[Environment]]''.

See the [{{Release notes}} release notes] in the dev docs for software requirements.

Notes:

* You can only upgrade to Moodle {{Version}} from Moodle 3.1 or later. If upgrading from earlier versions, you must [https://docs.moodle.org/31/en/Upgrading_to_Moodle_3.1 upgrade to 3.1] as a first step.
* The minimum PHP version has increased and is now 7.0.0. PHP 7.3 support is being implemented (MDL-63420) for Moodle 3.6.x and later releases. Hence it's still incomplete and only for development purposes.
* The PHP extension '''intl''' is now required in Moodle 3.4 (previously it was only recommended).

==Before upgrading==

'''We advise that you test the upgrade first on a COPY of your production site, to make sure it works as you expect.'''

Consider setting the [[Upgrade key|upgrade key]] for your site.

== Backup important data ==

There are three areas that should be backed up before any upgrade:
#Moodle software (For example, everything in server/htdocs/moodle)
#Moodle uploaded files (For example, server/moodledata)
#Moodle database (For example, your Postgres or MySQL database dump)

See [[Site backup]] for more specific information.

== Check for plugin updates ==

If you have [[Automatic updates deployment]] enabled, you will be able to update installed plugins automatically during the upgrade. Just make sure you check for available updates (via the button for it) at the Plugins check screen.

If you are updating plugins manually, it is a good moment now to check in the [http://moodle.org/plugins Moodle Plugins directory] whether there is a {{Version}} version available for any plugins (including themes) that you have previously installed on your site. If so, download the plugin package. In the next step, you will copy it to the appropriate location in your Moodle code (see [[Installing plugins]]).

The upgrade of the plugin will then happen as part of the Moodle upgrade process.

If an out-of-date plugin causes your upgrade to fail, you can usually delete the plugin code rather than uninstalling it from within Moodle so that the data associated with it is not deleted.

==Put your site into maintenance mode==
Before you begin upgrading your site, you should put it into [[Maintenance_mode | maintenance mode]] to stop any non-admin users from logging in. Then you should wait for any currently running cron processes to complete before proceeding.

== Install the new Moodle software ==
You can fetch the current version of the software through

wget http://sourceforge.net/projects/moodle/files/Moodle/stable{{Version2}}/moodle-latest-{{Version2}}.tgz

=== Standard install package ===

# Move your old Moodle software program files to another location. ''Do NOT copy new files over the old files.''
# Unzip or unpack the upgrade file so that all the new Moodle software program files are in the location the old files used to be in on the server. Moodle will adjust SQL and moodledata if it needs to in the upgrade.
# Copy your old [[Configuration file|config.php file]] back to the new Moodle directory.
# As mentioned above, if you had installed any plugins on your site you should add them to the new code tree (Moodle directory structure) now. It is important to check that you get the correct version for your new version of Moodle. Be particularly careful that you do not overwrite any code in the new version of Moodle and that you place the plugin folders in the correct directory (the same directory that they are in in the current installation.)
# Your moodledata folder should be located separately to your Moodle code folder and, as such, should not need anything done to it. Moodle 3.0 will throw a warning if it is located in a web accessible folder and the moodledata should never be located in the Moodle code folder. If you are moving your installation to a new server or new location on your server, then you will need to follow the Migration documents.

====Linux====
mv moodle moodle.backup
tar xvzf moodle-{{Version}}.tgz

Next, copy across your config.php, any custom plugins, and your .htaccess file if you created one ('''check that custom plugins are the correct version for your new Moodle first'''):

cp moodle.backup/config.php moodle
cp -pr moodle.backup/theme/mytheme moodle/theme/mytheme
cp -pr moodle.backup/mod/mymod moodle/mod/mymod

Don't forget to make moodle/config.php (and the rest of the source code) readable by your www server. Ideally the files should not be writeable by your server.

chown -R www-data:www-data moodle (Linux debian - change to appropriate user and group for your OS version)
chmod -R 755 moodle

If you use cron, take care that cron.php is executeable and uses the correct php command:
chmod 740 admin/cli/cron.php (some configurations need chmod 750 or chmod 755)
copy the first line from cron.php (if it looks like '#!/usr/local/bin/php' or '#!/usr/local/bin/php5.3', no need to copy '<?php')
if necessary. However, for a simple upgrade, there should be no need to change anything with cron.

=== Using Git ===

You can use Git for updating or upgrading your Moodle. See [[Git for Administrators]] for details.

===Command line upgrade===

On Linux servers, Moodle {{Version}} supports running the [[CLI|upgrade from the command line]], rather than through a web browser. This is likely to be more reliable, particularly for large sites.

== Finishing the upgrade ==

The last step is to trigger the upgrade processes within Moodle.

If you put your site into Maintenance mode earlier; take it out now!

To do this just go to ''Administration > Site administration > Notifications''.

Moodle will automatically detect the new version and perform all the SQL database or file system upgrades that are necessary. If there is anything it can't do itself (very rare) then you will see messages telling you what you need to do.

Assuming all goes well (no error messages) then you can start using your new version of Moodle and enjoy the new features!

Note: If you are running multiple servers then you should purge all caches manually (via ''Administration > Site administration > Development > Purge all caches'') after completing the upgrade on all servers.

===Fatal error: Maximum execution time of 30 seconds exceeded...===

If your server uses a main language other than English, you may encounter a 'Fatal error: Maximum execution time of 30 seconds exceeded' when you try to upgrade it. You can increase max_execution_time = 160 on php.ini to allow the scripts enough time to process the language update. Otherwise, you can switch to English as the default language before doing the upgrade and back to your original language after a succcessful upgrade. See the forum discussion at https://moodle.org/mod/forum/discuss.php?d=119598.

==After upgrading==

The config.php file from your installation should work fine but if you take a look at config-dist.php that came with Moodle 3.0 there are more/different options available (e.g. database drivers and settings). It's a good idea to map your old config.php settings to a new one based on the 3.0 config-dist.php.

===Cron===

Cron has received a major update (MDL-25499) and now has support for both scheduled and ad hoc tasks.

The benefits of these changes are:
* The schedule for every task can be configured by the admin
* Tasks can run in parallel
* Cron processes use locking to prevent the same task running at the same time by different processes
* Clusters with multiple identical application nodes are supported, you can run cron on all of them

A result of this is that cron can be run much more often, which means (for example) forum posts can be sent out sooner. To take advantage of the new cron system it is now strongly recommended that administrators increase the frequency that cron is run to at least ''once per minute''.

You also may need to modify any automated scripts you have that are parsing the output from cron. It is no longer possible to simply monitor the output of cron for the string "Cron script completed correctly" (if that is what you were doing). An alternative is to monitor the output for the string "task failed:". If you detect that a task is failing, [[Cron#Debugging_Scheduled_Tasks|here]] are some tips for debugging the failure.

Before the upgrade, there may have been a cron task that was failing, which was preventing the rest of cron from being executed. A failure in any single task will no longer prevent the rest of the Moodle cron tasks from executing, so you may uncover previously masked bugs. It is a good idea to closely monitor the output from cron after the upgrade.

===Assignments===

The old assignment (2.2) module has been removed from core and has been replaced by a stub to support transparently remapping URLs and restoring course backups from the old module to the new one.

If you are still using the old assignment (2.2) module, after upgrading to Moodle 3.0 all assignment (2.2) activities will be hidden. You need to run the [[Assignment upgrade tool]] to un-hide the activities.

If you really, really need to keep using the old assignment (2.2) module, you should update the code to Moodle 3.0, and then replace the "mod/assignment" folder with the one from https://github.com/moodlehq/moodle-mod_assignment/releases before completing the upgrade.

==Possible issues that may affect you in Moodle {{Version}}==

* To use 'Run now' links in [[Scheduled tasks]], you need to set 'Path to PHP CLI' (pathtophp) in Site administration > Server > System paths.

''Items to be added...''

See also the list of [https://tracker.moodle.org/issues/?jql=project%20%3D%20mdl%20AND%20resolution%20%3D%20fixed%20AND%20fixVersion%20in%20(%223.6%22)%20AND%20labels%20%3D%20upgrade_notes upgrade_notes-labelled issues] and [https://tracker.moodle.org/issues/?jql=project%20%3D%20mdl%20AND%20resolution%20%3D%20fixed%20AND%20fixVersion%20in%20(%223.6%22)%20AND%20labels%20%3D%20ui_change%20 ui_change-labelled issues].

=== Moodle 3.1, 3.2, 3.3, 3.4 and 3.5 improvements ===

Depending on which version you are upgrading from, please see the section 'Possible issues that may affect you' in the documentation

* [https://docs.moodle.org/31/en/Upgrading Upgrading to Moodle 3.1]
* [https://docs.moodle.org/32/en/Upgrading Upgrading to Moodle 3.2]
* [https://docs.moodle.org/33/en/Upgrading Upgrading to Moodle 3.3]
* [https://docs.moodle.org/34/en/Upgrading Upgrading to Moodle 3.4]
* [https://docs.moodle.org/35/en/Upgrading Upgrading to Moodle 3.5]

==See also==

* [[Installation]]
* Using Moodle [http://moodle.org/mod/forum/view.php?id=28 Installation help forum]
* [[dev:Moodle {{Version}} release notes|Moodle {{Version}} release notes]]

[[es:Actualización de moodle]]
[[fr:Mise à jour]]
[[ja:Moodleをアップグレードする]]
[[de:Aktualisierung von Moodle]]

Upgrading

2018-07-01T22:13:09Z

Stronk7: Add a note in upgrade about the new PostgreSQL default behavior in 3.5 and up.

{{Installing Moodle}}
''This page explains in detail how to upgrade Moodle. For a summary of the process, see [[Upgrade overview]].''

==Check the requirements==

Check that your server meets all requirements for {{Version}} in ''Administration > Site administration > Server > [[Environment]]''.

See the [{{Release notes}} release notes] in the dev docs for software requirements.

Notes:

* You can only upgrade to Moodle {{Version}} from Moodle 3.1 or later. If upgrading from earlier versions, you must [https://docs.moodle.org/31/en/Upgrading_to_Moodle_3.1 upgrade to 3.1] as a first step.
* The minimum PHP version has increased and is now 7.0.0.
* The PHP extension '''intl''' is now required in Moodle 3.4 (previously it was only recommended).

==Before upgrading==

'''We advise that you test the upgrade first on a COPY of your production site, to make sure it works as you expect.'''

Consider setting the [[Upgrade key|upgrade key]] for your site.

== Backup important data ==

There are three areas that should be backed up before any upgrade:
#Moodle software (For example, everything in server/htdocs/moodle)
#Moodle uploaded files (For example, server/moodledata)
#Moodle database (For example, your Postgres or MySQL database dump)

See [[Site backup]] for more specific information.

== Check for plugin updates ==

If you have [[Automatic updates deployment]] enabled, you will be able to update installed plugins automatically during the upgrade. Just make sure you check for available updates (via the button for it) at the Plugins check screen.

If you are updating plugins manually, it is a good moment now to check in the [http://moodle.org/plugins Moodle Plugins directory] whether there is a {{Version}} version available for any plugins (including themes) that you have previously installed on your site. If so, download the plugin package. In the next step, you will copy it to the appropriate location in your Moodle code (see [[Installing plugins]]).

The upgrade of the plugin will then happen as part of the Moodle upgrade process.

If an out-of-date plugin causes your upgrade to fail, you can usually delete the plugin code rather than uninstalling it from within Moodle so that the data associated with it is not deleted.

==Put your site into maintenance mode==
Before you begin upgrading your site, you should put it into [[Maintenance_mode | maintenance mode]] to stop any non-admin users from logging in. Then you should wait for any currently running cron processes to complete before proceeding.

== Install the new Moodle software ==
You can fetch the current version of the software through

wget http://sourceforge.net/projects/moodle/files/Moodle/stable{{Version2}}/moodle-latest-{{Version2}}.tgz

=== Standard install package ===

# Move your old Moodle software program files to another location. ''Do NOT copy new files over the old files.''
# Unzip or unpack the upgrade file so that all the new Moodle software program files are in the location the old files used to be in on the server. Moodle will adjust SQL and moodledata if it needs to in the upgrade.
# Copy your old [[Configuration file|config.php file]] back to the new Moodle directory.
# As mentioned above, if you had installed any plugins on your site you should add them to the new code tree (Moodle directory structure) now. It is important to check that you get the correct version for your new version of Moodle. Be particularly careful that you do not overwrite any code in the new version of Moodle and that you place the plugin folders in the correct directory (the same directory that they are in in the current installation.)
# Your moodledata folder should be located separately to your Moodle code folder and, as such, should not need anything done to it. Moodle 3.0 will throw a warning if it is located in a web accessible folder and the moodledata should never be located in the Moodle code folder. If you are moving your installation to a new server or new location on your server, then you will need to follow the Migration documents.

====Linux====
mv moodle moodle.backup
tar xvzf moodle-{{Version}}.tgz

Next, copy across your config.php, any custom plugins, and your .htaccess file if you created one ('''check that custom plugins are the correct version for your new Moodle first'''):

cp moodle.backup/config.php moodle
cp -pr moodle.backup/theme/mytheme moodle/theme/mytheme
cp -pr moodle.backup/mod/mymod moodle/mod/mymod

Don't forget to make moodle/config.php (and the rest of the source code) readable by your www server. Ideally the files should not be writeable by your server.

chown -R www-data:www-data moodle (Linux debian - change to appropriate user and group for your OS version)
chmod -R 755 moodle

If you use cron, take care that cron.php is executeable and uses the correct php command:
chmod 740 admin/cli/cron.php (some configurations need chmod 750 or chmod 755)
copy the first line from cron.php (if it looks like '#!/usr/local/bin/php' or '#!/usr/local/bin/php5.3', no need to copy '<?php')
if necessary. However, for a simple upgrade, there should be no need to change anything with cron.

=== Using Git ===

You can use Git for updating or upgrading your Moodle. See [[Git for Administrators]] for details.

===Command line upgrade===

On Linux servers, Moodle {{Version}} supports running the [[CLI|upgrade from the command line]], rather than through a web browser. This is likely to be more reliable, particularly for large sites.

== Finishing the upgrade ==

The last step is to trigger the upgrade processes within Moodle.

If you put your site into Maintenance mode earlier; take it out now!

To do this just go to ''Administration > Site administration > Notifications''.

Moodle will automatically detect the new version and perform all the SQL database or file system upgrades that are necessary. If there is anything it can't do itself (very rare) then you will see messages telling you what you need to do.

Assuming all goes well (no error messages) then you can start using your new version of Moodle and enjoy the new features!

Note: If you are running multiple servers then you should purge all caches manually (via ''Administration > Site administration > Development > Purge all caches'') after completing the upgrade on all servers.

===Fatal error: Maximum execution time of 30 seconds exceeded...===

If your server uses a main language other than English, you may encounter a 'Fatal error: Maximum execution time of 30 seconds exceeded' when you try to upgrade it. You can increase max_execution_time = 160 on php.ini to allow the scripts enough time to process the language update. Otherwise, you can switch to English as the default language before doing the upgrade and back to your original language after a succcessful upgrade. See the forum discussion at https://moodle.org/mod/forum/discuss.php?d=119598.

==After upgrading==

The config.php file from your installation should work fine but if you take a look at config-dist.php that came with Moodle 3.0 there are more/different options available (e.g. database drivers and settings). It's a good idea to map your old config.php settings to a new one based on the 3.0 config-dist.php.

===Cron===

Cron has received a major update (MDL-25499) and now has support for both scheduled and ad hoc tasks.

The benefits of these changes are:
* The schedule for every task can be configured by the admin
* Tasks can run in parallel
* Cron processes use locking to prevent the same task running at the same time by different processes
* Clusters with multiple identical application nodes are supported, you can run cron on all of them

A result of this is that cron can be run much more often, which means (for example) forum posts can be sent out sooner. To take advantage of the new cron system it is now strongly recommended that administrators increase the frequency that cron is run to at least ''once per minute''.

You also may need to modify any automated scripts you have that are parsing the output from cron. It is no longer possible to simply monitor the output of cron for the string "Cron script completed correctly" (if that is what you were doing). An alternative is to monitor the output for the string "task failed:". If you detect that a task is failing, [[Cron#Debugging_Scheduled_Tasks|here]] are some tips for debugging the failure.

Before the upgrade, there may have been a cron task that was failing, which was preventing the rest of cron from being executed. A failure in any single task will no longer prevent the rest of the Moodle cron tasks from executing, so you may uncover previously masked bugs. It is a good idea to closely monitor the output from cron after the upgrade.

===Assignments===

The old assignment (2.2) module has been removed from core and has been replaced by a stub to support transparently remapping URLs and restoring course backups from the old module to the new one.

If you are still using the old assignment (2.2) module, after upgrading to Moodle 3.0 all assignment (2.2) activities will be hidden. You need to run the [[Assignment upgrade tool]] to un-hide the activities.

If you really, really need to keep using the old assignment (2.2) module, you should update the code to Moodle 3.0, and then replace the "mod/assignment" folder with the one from https://github.com/moodlehq/moodle-mod_assignment/releases before completing the upgrade.

==Possible issues that may affect you in Moodle {{Version}}==

* 'Site policies' in the Site administration has been renamed '[[Site security settings]]'.

* Moodle presets have changed. Most of the Bootstrap 4 variables have changed and the way bootstrap, font awesome and core scss is included. For more info on the Bootstrap 4 changes visit https://getbootstrap.com/docs/4.0/migration/
<code php>
// Example code, place scss variables here.
// $font-size-base: 0.9375rem

// Import FontAwesome.
@import "fontawesome";

// Import All of Bootstrap.
@import "bootstrap";

// Import Core moodle CSS.
@import "moodle";

// Example code, place scss using Bootstrap mixins and extends here.
// .navbar {
// @include shadow();
// }
</code>

* The PostgreSQL driver has been improved and, now, the <tt>get_recordset_xxx()</tt> operations don't fetch all the records into memory for big (>100000) datasets. This can be configured or disabled using the new <tt>fetchbuffersize</tt> [https://github.com/moodle/moodle/blob/f61ee4e857a894a5b8b69516b00be88ae499964b/config-dist.php#L73 dboption]. Note this is known to affect installations using pg_bouncer in transaction mode. See MDL-60174 for more information.

See also the list of [https://tracker.moodle.org/issues/?jql=project%20%3D%20mdl%20AND%20resolution%20%3D%20fixed%20AND%20fixVersion%20in%20(%223.5%22)%20AND%20labels%20%3D%20ui_change%20 issues fixed in Moodle 3.5 which are labelled ui_change].

=== Moodle 3.1, 3.2, 3.3 and 3.4 improvements ===

Depending on which version you are upgrading from, please see the section 'Possible issues that may affect you' in the documentation

* [https://docs.moodle.org/31/en/Upgrading Upgrading to Moodle 3.1]
* [https://docs.moodle.org/32/en/Upgrading Upgrading to Moodle 3.2]
* [https://docs.moodle.org/33/en/Upgrading Upgrading to Moodle 3.3]
* [https://docs.moodle.org/34/en/Upgrading Upgrading to Moodle 3.4]

==See also==

* [[Installation]]
* Using Moodle [http://moodle.org/mod/forum/view.php?id=28 Installation help forum]
* [[dev:Moodle {{Version}} release notes|Moodle {{Version}} release notes]]

[[es:Actualización de moodle]]
[[fr:Mise à jour]]
[[ja:Moodleをアップグレードする]]
[[de:Aktualisierung von Moodle]]

Complete install packages for Windows

2018-05-19T18:50:12Z

Stronk7: typo

{{Installing Moodle}}
Complete install packages are available from Moodle.org's [https://download.moodle.org/windows/ Windows download page] and also from [https://bitnami.com/stacks Bitnami stacks]. The packages are designed for new installations on a standalone computer. All them use the popular [https://www.apachefriends.org/ XAMPP Apache Friends packages]. The complete install package can be used on a server, but '''it is not recommended that it be used as a production site'''. Please note Moodle.org's [http://download.moodle.org Standard install packages] only contain the Moodle code.

This document provides instructions for using the Windows packages. Separate instructions are available for [[Complete Install Packages for Mac OS X|Mac OS X packages]].

The complete install packages allow Moodle to be installed, along with the prerequisites that includes a web server, Apache, database, MySQL, scripting language, PHP and Moodle all wrapped in the Xampp-lite shell. Several versions of the complete install package are available. The instructions on the download page provide guidance on which version is likely to be most suitable.

In short, complete install packages are designed to create a matched webserver and Moodle site on a standalone computer with minimal effort.

==System requirements==
:*256 MB RAM (minimum), 1GB RAM (recommended)
:*500 MB free Fixed Disk (more space will be needed depending on user uploads)
:* For old versions of Moodle:
:**Windows 98/ME (minimum)
:**Windows NT/2000/XP/2003 (recommended)
:* For Moodle 3.1 and later versions:
:**Windows Vista/7/8/10/2008/2012
:**Microsoft Visual C++ 2015 Redistributable package is required for PHP ([https://www.microsoft.com/en-us/download/details.aspx?id=48145 download link)]. This must be the '''vc_redist.x86.exe''' download as the PHP build is 32-bit.

===Port 80 Conflict if Skype is already installed===
As the Moodle Windows package uses the same port (80) as [http://www.skype.com/en/ Skype] does, it will not work if the computer has Skype already installed.

The fix is very simple: Exit Skype (don't just close the window), then start the Moodle Windows package. Once Moodle for Windows is running, it should be safe to start Skype again. If the local Moodle is using the port 80, Skype will automatically select a different port when it is run.

===Vista and Windows 7/8/10===

Packages generated for Moodle 3.1 and later versions should work with Vista/7/8/10 out of the box. They include PHP 7 and MariaDB instead of MySQL, resulting in a smoother experience than previous versions of the packages.

People facing problems with the new packages should:

:* Read the Requirements and Troubleshooting information, both here and in the package's README.txt file.
:* Report any consistent problem in the [https://tracker.moodle.org Moodle Tracker], so it can be investigated and, hopefully, fixed.
:* Consider installing a virtual machine (eg, [https://www.virtualbox.org/ VirtualBox]) with a windows or linux LAMP stack and then install Moodle there.
:* Use other Moodle-ready alternatives [https://moodlecloud.com out there].

==Install complete package process==
The complete install package is a zip file that contains a webserver called [[Apache]], plus Moodle and Moodle's required [[MySQL]] database and [[PHP]] program.

There are three basic parts to the this install process.
#Download and unpack the complete install package.
#Start the webserver.
#Install Moodle using a web browser.

===First create file structure===
====Download the package====
[http://download.moodle.org/windows Download Windows] packed-zip file from Moodle.

====Unpack the package====
Unpack (extract files by clicking on) the zip file you downloaded to a drive or partition of your choice. The extract process will create three files ("Start Moodle", "Stop Moodle", and "README") and a subfolder called "server".
*Do NOT rename the "server" subfolder
:''Note:'' There will also be a folder under this server subfolder, called \moodle that holds the Moodle program.

:''TIP:'' Create a folder and extract the files there. For example, you might have one folder called Moodle254 and another one called Moodle281 for different versions or purposes.

:''TIP:'' Make path to "server" subfolder simple. Best way if it will be in drive root. Like "D:\moodle281\server". A long path, especially with any strange symbols, can prevent XAMPP from working properly.

:''NOTE:'' If you will be installing a server with a language other than English, the install process will need to download the corresponding language pack, which will take some time, and you will likely get a script timeout error. To prevent this, you will need to edit the server/php/php.ini file and change the line that has 'max_execution_time = 30' into 'max_execution_time = 600'.

===Second - start the webserver===
Now you are ready to start the webserver. Use the "Start Moodle.exe" file which you should find in the top directory. Once the "Start Moodle.exe" program is open, don't close it; use "Stop Moodle.exe" for that purpose.

:''Note:'' These programs control both Apache and MySQL programs that operate the webserver. Some sites will individually start and stop Apache and MySQL with the Xampp bat files found in the "server" subfolder.

:''Tip:'' Alternatively, on a standalone computer with several potential webservers that might be running, you can use the "xampp_restart.exe" file in the "server" subfolder.

:''Tip:'' You can also add shortcuts to the commands that start and stop the site in your Windows "start" menu.

Now you are ready to start the Moodle installation.

:''Warning:'' Windows XP requires the msvcr71.dll library file in order to run Xampp. Installing the [http://www.microsoft.com/downloads/details.aspx?familyid=262D25E3-F589-4842-8157-034D1E7CF3A3&displaylang=en .Net 1.1 framework] (not .Net 2.0 and upper) could resolve it. You can also search for the file on Google, download it and copy it into the server/apache/bin folder.

===Third - start Moodle installation===
Start your web browser and type <nowiki> localhost, or http://127.0.0.1 or http://localhost </nowiki>in the address bar. You will either start your first time Moodle installation or if it is already installed you will enter the Moodle site's [[Front Page]] or Login screen.

[[Image:Moodle_Setup_localhost_browser.jpg|frame|center|A browser's addressbar showing "localhost". Click on the green Goto arrow will go to the installed Moodle site.]]

:''Tip:'' After Moodle installs, put the site in your "favorites" or as a "bookmark" in you browser.

====Set language====
The initial install page will be displayed after you type "localhost".

[[Image:C Install Windows 1.png|thumb|center|600px|Set initial language]]

*Choose your preferred language (English is used in this example) and click the “Next” button.

====Diagnostic results====
A diagnostic report is displayed – hopefully it will look like this, if not you may need to address some issues.
[[Image:Complete Windows Install 2.png|thumb|center|546px|Moodle liked and gave a Pass ]]

*Click the “Next” button to continue.

====Moodle paths====
The paths for your Moodle installation are shown – if you are only using this as a local testing server, accept the ones that are shown on your screen.

What you enter in the "Web Address" field depends on what you intend to use the new Moodle installation for.
If you are just going to use it for local testing, then use 'http://localhost'.
If you are going to test the new installation on a LAN, and will be accessing it from other machines on that LAN, then put the private IP address or network name of the serving machine, followed by a forward slash and moodle: Web Address - http://192.168.1.1/moodle
If you are going to test the installation on the internet, then you will need to put the public ip address followed by a forward slash and moodle: http://your_ip_address/moodle or you can put your domain name here instead.

[[image:Complete install Windows 3.png|thumb|center|600px|Installation paths]]

*Click the “Next” button to continue.

====Database configuration====
*In the next fields, we enter the database settings. The fields are populated with some suggested values.

*We strongly recommend you place a user name and password in this screen. (Don't forget them).

*DO NOT USE THE “ROOT” USER WITHOUT A PASSWORD FOR PRODUCTION INSTALLATIONS AS THIS CREATES A SECURITY VULNERABILITY
[[image:Complete install Windows 4.png|thumb|center|535px|Installation's database settings]]

*When the fields have been populated, click the “Next” button to continue.

====Check server====
The install process checks the server is installed. All the checks should pass as far as the [[#System_requirements|system requirements]] have been fulfilled.
[[image:Complete install Windows 5.png|thumb|center|535px|Check server environment screen]]
*Click the “Next” button to continue.

====Confirm initial language pack====
Moodle will now check to see if the language pack is available for the language you selected at the first step. If it is not, Moodle will continue with the install in English.
[[image:Complete install Windows 6.png|thumb|center|535px|Language pack check]]

====Confirm config.php====
Provided the Moodle folder is writable, a message confirming the configuration has been completed will be displayed.
[[image:Complete install Windows 7.png|thumb|center|549px|Confirmation that config.php has been created]]

*Click the “ Continue” button to proceed.

====Moodle copyright & agreement====
The Moodle copyright / license notices are displayed.

[[image:Complete install Windows 8.png|thumb|center|400px|Copyright notice and agreement]]

*Click the “Yes” button to continue.

====Current release and unattended option====
The current release information is shown.
'''Check off the unattended operations box'''. This will automatically advance through many screens. If you would like to watch the install screen by screen, do not check this box and be prepared to press the "continute button" many times.

*Click the "Continue" button and wait.
[[Image:Complete install Windows 9.png|thumb|center|600px|Current release and "unattended" check box]]

====Installation modules and blocks screens====
In most cases this will be followed by a series of screens that have a continue button on the bottom. This process stops with Admin user profile settings which needs to be filled out.

====Administrator user profile====
[[Image:Complete install Windows 10.png|thumb|center|The administrator's users profile screen]]

Fill out the required fields.
*Click on "Save" to continue

====Front page settings====
The next screen is the Front Page settings page. There are two parts to it.
The first part will ask for your Full site name and a short name for the navigation bar. There is also a place for a description. You can change these later.

[[Image:Complete install Windows 11a.png|thumb|center|The Moodle sites [[Front Page]] information]]

The second part on the bottom instructs Moodle if you will disable the new user self [[Authentication|authentication]] through email process. The default is to disable. This can be changed later in the [[Site administration block|site administration block]].

[[Image:Complete install Windows 11ba.png|thumb|center|500px|Determine if users can create their own profiles when they log onto the side via email self authentication]]

*Click on "Save changes" button to go to Moodle sites home page.

====Moodle on====
'''Now you are ready to Moodle !'''

[[Image:Complete install Windows 12.png|thumb|center|Blank Front page of your new site]]

The Site Administration block is on the left, the "Turn edit on" button in the upper right corner, withe the site description block just below it.

===Congratulations - Moodle has been installed===
This finishes the installation of a complete package. Type <nowiki>http://localhost</nowiki> (or what ever you set for web address earlier in the setup!) in your browser and Moodle will open.

Your next task will be to configure Moodle to meet your needs. Don't worry, it is easy to change any of the settings now that Moodle is up and running.
*Check ''Settings > Site administration'' for further links.

==More tips and cautions==
*For installation on a Windows 2000 or Windows 2003 production server it is good practice to perform a manual install (see the manual installation section in [[Windows_installation|Windows Installation]]).

*After installing the Windows package, you may wish to add additional contributed modules and plugins. Theset may involve more customization of configuration files.

*The latest complete install package version components, may not be backwardly compatible. Always check version compatibility of each component if you intend to develop materials on a later version of Moodle than the version installed on your "main" Moodle site. In short, complete install packages are designed for first time install on a "clean" machine.

== Security matters (A MUST READ!)==

As mentioned before, XAMPP is not meant for production use but only for developers
in a development environment. The way XAMPP is configured is to be open as possible
and allowing the developer anything he/she wants. For development environments this
is great but in a production environment it could be fatal. Here a list of missing security
in XAMPP:

The MySQL administrator (root) has no password.
The MySQL daemon is accessible via network.
Examples are accessible via network.

To fix most of the security weaknesses simply call the following URL:

<nowiki>http://localhost/security/</nowiki>

The root password for MySQL and also a XAMPP directory protection can be established here.

Note that on the Windows installer package, some (all?) of these issues have been fixed already by default and the above link does not work.

If in doubt, more info is [http://www.apachefriends.org/en/faq-xampp-windows.html here]

== Apache and MySQL tweaks ==
Most of the time it is not necessary to tweak Apache or MySQL after completing the complete install package. Nor is it necessary to individually start and stop them because that is what the Xampp_start, Xampp_restart and Xammp_stop files are for.

=== Installing Apache and MySQL as services===
(This is only for NT4 | Windows 2000 | Windows XP operating systems)

\xampplite\apache\apache_installservice.bat =
==> Install Apache 2 as service

\xampplite\apache\apache_uninstallservice.bat =
==> Uninstall Apache 2 as service

\xampplite\mysql\mysql_installservice.bat =
==> Install MySQL as service

\xampplite\mysql\mysql_uninstallservice.bat =
==> Uninstall MySQL as service

==> After all Service (un)installations, please restart your system!

===Apache Notes===

You can use the apache_start and apache_stop bat files to start and stop apache from running. However the Xampp_start or Xampp_restart and Xampp_stop is recommended to turn on/off both Apache and MySQL.

====Troubleshooting====

If you find that Apache is very flaky, with the page often not loading properly or even at all (especially on localhost), try adding these lines to the end of C:\your_moodle_installer_directory\apache\conf\httpd.conf

EnableSendfile Off
EnableMMAP Off
Win32DisableAcceptEx

If You edit some .php files but browser still show old state of them, try to disable eAccelerator extension in \server\php\php.ini

[eAccelerator]
;extension=eaccelerator.dll

===MySQL notes===
Again, the recommendation to start and stop the entire webserver is to use the xampp_start or Xampp_restart and the Xampp_stop. The following maybe useful if you wish to tweak the system further. Please be careful.

(1) The MySQL server can be started by double-clicking (executing) mysql_start.bat. This file can be found in the same folder you installed xampp in, most likely this will be C:\xampplite\. The exact path to this file is X:\xampplite\mysql_start.bat, where "X" indicates the letter of the drive you unpacked xampp into.This batch file starts the MySQL server in console mode. The first intialization might take a few minutes.

Do not close the DOS window or you'll crash the server! To stop the server, please use mysql_shutdown.bat, which is located in the same directory.

(2) To use the MySQL Daemon with "innodb" for better performance,
please edit the "my" (or "my.cnf") file in the /xampplite/mysql/bin directory or for services the c:\my.cnf for windows NT/2000/XP. In that director, activate the
"innodb_data_file_path=ibdata1:30M"
statement. Attention, "innodb" is not recommended for 95/98/ME.

:To use MySQL as Service for NT/2000/XP, simply copy the "my" / "my.cnf" file to C:\my, or C:\my.cnf. Please note that this file has to be placed in C:\ (root), other locations are not permitted. Then execute the "mysql_installservice.bat" in the mysql folder.

(3) MySQL starts with standard values for the user id and the password. The preset user id is "root", the password is "" (= no password). To access MySQL via PHP with the preset values, you'll have to use the following syntax:
mysql_connect("localhost","root","");
If you want to set a password for MySQL access, please use of mysqladmin.
To set the password "secret" for the user "root", type the following:

\xampplite\mysql\bin\mysqladmin -u root password secret

Have a lot of fun! Viel Spaß! Bonne Chance!

==See also==

*[https://docs.moodle.org/19/en/Installation_guide_-_Moodle_for_Windows_on_a_USB_Memory_Stick Installation guide - Moodle 1.9 for Windows on a USB Memory Stick]
*Return to [[Windows installation]]
*[[Windows 1 computer many servers |Multiple web servers, on 1 computer]] similar to windows installation page, with some tips
*[https://docs.moodle.org/en/Windows_installation_using_XAMPP#Troubleshooting Troubleshooting]if you are running Skype.
*[[Installing_AMP]] lots of XAMPP stuff. XAMPP stands for X (cross platform), Apache, MySQL,PHP and Perl. XAMPP used in Moodle does not include Perl. MAMP stands for Mac, Apache, MySQL and PHP.
*[[Installation Package for OS X]]

[[es:Paquetes para Instalación Completa para Windows]]
[[pl:Kompletne pakiety instalacyjne]]
[[de:Vollständiges Installationspaket für Windows]]

[[Category:Installation]]
[[Category:Windows]]

Complete install packages for Windows

2018-05-19T18:44:16Z

Stronk7: remember system requirements

{{Installing Moodle}}
Complete install packages are available from Moodle.org's [https://download.moodle.org/windows/ Windows download page] and also from [https://bitnami.com/stacks Bitnami stacks]. The packages are designed for new installations on a standalone computer. All them use the popular [https://www.apachefriends.org/ XAMPP Apache Friends packages]. The complete install package can be used on a server, but '''it is not recommended that it be used as a production site'''. Please note Moodle.org's [http://download.moodle.org Standard install packages] only contain the Moodle code.

This document provides instructions for using the Windows packages. Separate instructions are available for [[Complete Install Packages for Mac OS X|Mac OS X packages]].

The complete install packages allow Moodle to be installed, along with the prerequisites that includes a web server, Apache, database, MySQL, scripting language, PHP and Moodle all wrapped in the Xampp-lite shell. Several versions of the complete install package are available. The instructions on the download page provide guidance on which version is likely to be most suitable.

In short, complete install packages are designed to create a matched webserver and Moodle site on a standalone computer with minimal effort.

==System requirements==
:*256 MB RAM (minimum), 1GB RAM (recommended)
:*500 MB free Fixed Disk (more space will be needed depending on user uploads)
:* For old versions of Moodle:
:**Windows 98/ME (minimum)
:**Windows NT/2000/XP/2003 (recommended)
:* For Moodle 3.1 and later versions:
:**Windows Vista/7/8/10/2008/2012
:**Microsoft Visual C++ 2015 Redistributable package is required for PHP ([https://www.microsoft.com/en-us/download/details.aspx?id=48145 download link)]. This must be the '''vc_redist.x86.exe''' download as the PHP build is 32-bit.

===Port 80 Conflict if Skype is already installed===
As the Moodle Windows package uses the same port (80) as [http://www.skype.com/en/ Skype] does, it will not work if the computer has Skype already installed.

The fix is very simple: Exit Skype (don't just close the window), then start the Moodle Windows package. Once Moodle for Windows is running, it should be safe to start Skype again. If the local Moodle is using the port 80, Skype will automatically select a different port when it is run.

===Vista and Windows 7/8/10===

Packages generated for Moodle 3.1 and later versions should work with Vista/7/8/10 out of the box. They include PHP 7 and MariaDB instead of MySQL, resulting in a smoother experience than previous versions of the packages.

People facing problems with the new packages should:

:* Read the Requirements and Troubleshooting information, both here and in the package's README.txt file.
:* Report any consistent problem in the [https://tracker.moodle.org Moodle Tracker], so it can be investigated and, hopefully, fixed.
:* Consider installing a virtual machine (eg, [https://www.virtualbox.org/ VirtualBox]) with a windows or linux LAMP stack and then install Moodle there.
:* Use other Moodle-ready alternatives [https://moodlecloud.com out there].

==Install complete package process==
The complete install package is a zip file that contains a webserver called [[Apache]], plus Moodle and Moodle's required [[MySQL]] database and [[PHP]] program.

There are three basic parts to the this install process.
#Download and unpack the complete install package.
#Start the webserver.
#Install Moodle using a web browser.

===First create file structure===
====Download the package====
[http://download.moodle.org/windows Download Windows] packed-zip file from Moodle.

====Unpack the package====
Unpack (extract files by clicking on) the zip file you downloaded to a drive or partition of your choice. The extract process will create three files ("Start Moodle", "Stop Moodle", and "README") and a subfolder called "server".
*Do NOT rename the "server" subfolder
:''Note:'' There will also be a folder under this server subfolder, called \moodle that holds the Moodle program.

:''TIP:'' Create a folder and extract the files there. For example, you might have one folder called Moodle254 and another one called Moodle281 for different versions or purposes.

:''TIP:'' Make path to "server" subfolder simple. Best way if it will be in drive root. Like "D:\moodle281\server". A long path, especially with any strange symbols, can prevent XAMPP from working properly.

:''NOTE:'' If you will be installing a server with a language other than English, the install process will need to download the corresponding language pack, which will take some time, and you will likely get a script timeout error. To prevent this, you will need to edit the server/php/php.ini file and change the line that has 'max_execution_time = 30' into 'max_execution_time = 600'.

===Second - start the webserver===
Now you are ready to start the webserver. Use the "Start Moodle.exe" file which you should find in the top directory. Once the "Start Moodle.exe" program is open, don't close it; use "Stop Moodle.exe" for that purpose.

:''Note:'' These programs control both Apache and MySQL programs that operate the webserver. Some sites will individually start and stop Apache and MySQL with the Xampp bat files found in the "server" subfolder.

:''Tip:'' Alternatively, on a standalone computer with several potential webservers that might be running, you can use the "xampp_restart.exe" file in the "server" subfolder.

:''Tip:'' You can also add shortcuts to the commands that start and stop the site in your Windows "start" menu.

Now you are ready to start the Moodle installation.

:''Warning:'' Windows XP requires the msvcr71.dll library file in order to run Xampp. Installing the [http://www.microsoft.com/downloads/details.aspx?familyid=262D25E3-F589-4842-8157-034D1E7CF3A3&displaylang=en .Net 1.1 framework] (not .Net 2.0 and upper) could resolve it. You can also search for the file on Google, download it and copy it into the server/apache/bin folder.

===Third - start Moodle installation===
Start your web browser and type <nowiki> localhost, or http://127.0.0.1 or http://localhost </nowiki>in the address bar. You will either start your first time Moodle installation or if it is already installed you will enter the Moodle site's [[Front Page]] or Login screen.

[[Image:Moodle_Setup_localhost_browser.jpg|frame|center|A browser's addressbar showing "localhost". Click on the green Goto arrow will go to the installed Moodle site.]]

:''Tip:'' After Moodle installs, put the site in your "favorites" or as a "bookmark" in you browser.

====Set language====
The initial install page will be displayed after you type "localhost".

[[Image:C Install Windows 1.png|thumb|center|600px|Set initial language]]

*Choose your preferred language (English is used in this example) and click the “Next” button.

====Diagnostic results====
A diagnostic report is displayed – hopefully it will look like this, if not you may need to address some issues.
[[Image:Complete Windows Install 2.png|thumb|center|546px|Moodle liked and gave a Pass ]]

*Click the “Next” button to continue.

====Moodle paths====
The paths for your Moodle installation are shown – if you are only using this as a local testing server, accept the ones that are shown on your screen.

What you enter in the "Web Address" field depends on what you intend to use the new Moodle installation for.
If you are just going to use it for local testing, then use 'http://localhost'.
If you are going to test the new installation on a LAN, and will be accessing it from other machines on that LAN, then put the private IP address or network name of the serving machine, followed by a forward slash and moodle: Web Address - http://192.168.1.1/moodle
If you are going to test the installation on the internet, then you will need to put the public ip address followed by a forward slash and moodle: http://your_ip_address/moodle or you can put your domain name here instead.

[[image:Complete install Windows 3.png|thumb|center|600px|Installation paths]]

*Click the “Next” button to continue.

====Database configuration====
*In the next fields, we enter the database settings. The fields are populated with some suggested values.

*We strongly recommend you place a user name and password in this screen. (Don't forget them).

*DO NOT USE THE “ROOT” USER WITHOUT A PASSWORD FOR PRODUCTION INSTALLATIONS AS THIS CREATES A SECURITY VULNERABILITY
[[image:Complete install Windows 4.png|thumb|center|535px|Installation's database settings]]

*When the fields have been populated, click the “Next” button to continue.

====Check server====
The install process checks the server it installed. All the checks should pass as far as the [[#System_requirements|system requirements]] have been fulfilled.
[[image:Complete install Windows 5.png|thumb|center|535px|Check server environment screen]]
*Click the “Next” button to continue.

====Confirm initial language pack====
Moodle will now check to see if the language pack is available for the language you selected at the first step. If it is not, Moodle will continue with the install in English.
[[image:Complete install Windows 6.png|thumb|center|535px|Language pack check]]

====Confirm config.php====
Provided the Moodle folder is writable, a message confirming the configuration has been completed will be displayed.
[[image:Complete install Windows 7.png|thumb|center|549px|Confirmation that config.php has been created]]

*Click the “ Continue” button to proceed.

====Moodle copyright & agreement====
The Moodle copyright / license notices are displayed.

[[image:Complete install Windows 8.png|thumb|center|400px|Copyright notice and agreement]]

*Click the “Yes” button to continue.

====Current release and unattended option====
The current release information is shown.
'''Check off the unattended operations box'''. This will automatically advance through many screens. If you would like to watch the install screen by screen, do not check this box and be prepared to press the "continute button" many times.

*Click the "Continue" button and wait.
[[Image:Complete install Windows 9.png|thumb|center|600px|Current release and "unattended" check box]]

====Installation modules and blocks screens====
In most cases this will be followed by a series of screens that have a continue button on the bottom. This process stops with Admin user profile settings which needs to be filled out.

====Administrator user profile====
[[Image:Complete install Windows 10.png|thumb|center|The administrator's users profile screen]]

Fill out the required fields.
*Click on "Save" to continue

====Front page settings====
The next screen is the Front Page settings page. There are two parts to it.
The first part will ask for your Full site name and a short name for the navigation bar. There is also a place for a description. You can change these later.

[[Image:Complete install Windows 11a.png|thumb|center|The Moodle sites [[Front Page]] information]]

The second part on the bottom instructs Moodle if you will disable the new user self [[Authentication|authentication]] through email process. The default is to disable. This can be changed later in the [[Site administration block|site administration block]].

[[Image:Complete install Windows 11ba.png|thumb|center|500px|Determine if users can create their own profiles when they log onto the side via email self authentication]]

*Click on "Save changes" button to go to Moodle sites home page.

====Moodle on====
'''Now you are ready to Moodle !'''

[[Image:Complete install Windows 12.png|thumb|center|Blank Front page of your new site]]

The Site Administration block is on the left, the "Turn edit on" button in the upper right corner, withe the site description block just below it.

===Congratulations - Moodle has been installed===
This finishes the installation of a complete package. Type <nowiki>http://localhost</nowiki> (or what ever you set for web address earlier in the setup!) in your browser and Moodle will open.

Your next task will be to configure Moodle to meet your needs. Don't worry, it is easy to change any of the settings now that Moodle is up and running.
*Check ''Settings > Site administration'' for further links.

==More tips and cautions==
*For installation on a Windows 2000 or Windows 2003 production server it is good practice to perform a manual install (see the manual installation section in [[Windows_installation|Windows Installation]]).

*After installing the Windows package, you may wish to add additional contributed modules and plugins. Theset may involve more customization of configuration files.

*The latest complete install package version components, may not be backwardly compatible. Always check version compatibility of each component if you intend to develop materials on a later version of Moodle than the version installed on your "main" Moodle site. In short, complete install packages are designed for first time install on a "clean" machine.

== Security matters (A MUST READ!)==

As mentioned before, XAMPP is not meant for production use but only for developers
in a development environment. The way XAMPP is configured is to be open as possible
and allowing the developer anything he/she wants. For development environments this
is great but in a production environment it could be fatal. Here a list of missing security
in XAMPP:

The MySQL administrator (root) has no password.
The MySQL daemon is accessible via network.
Examples are accessible via network.

To fix most of the security weaknesses simply call the following URL:

<nowiki>http://localhost/security/</nowiki>

The root password for MySQL and also a XAMPP directory protection can be established here.

Note that on the Windows installer package, some (all?) of these issues have been fixed already by default and the above link does not work.

If in doubt, more info is [http://www.apachefriends.org/en/faq-xampp-windows.html here]

== Apache and MySQL tweaks ==
Most of the time it is not necessary to tweak Apache or MySQL after completing the complete install package. Nor is it necessary to individually start and stop them because that is what the Xampp_start, Xampp_restart and Xammp_stop files are for.

=== Installing Apache and MySQL as services===
(This is only for NT4 | Windows 2000 | Windows XP operating systems)

\xampplite\apache\apache_installservice.bat =
==> Install Apache 2 as service

\xampplite\apache\apache_uninstallservice.bat =
==> Uninstall Apache 2 as service

\xampplite\mysql\mysql_installservice.bat =
==> Install MySQL as service

\xampplite\mysql\mysql_uninstallservice.bat =
==> Uninstall MySQL as service

==> After all Service (un)installations, please restart your system!

===Apache Notes===

You can use the apache_start and apache_stop bat files to start and stop apache from running. However the Xampp_start or Xampp_restart and Xampp_stop is recommended to turn on/off both Apache and MySQL.

====Troubleshooting====

If you find that Apache is very flaky, with the page often not loading properly or even at all (especially on localhost), try adding these lines to the end of C:\your_moodle_installer_directory\apache\conf\httpd.conf

EnableSendfile Off
EnableMMAP Off
Win32DisableAcceptEx

If You edit some .php files but browser still show old state of them, try to disable eAccelerator extension in \server\php\php.ini

[eAccelerator]
;extension=eaccelerator.dll

===MySQL notes===
Again, the recommendation to start and stop the entire webserver is to use the xampp_start or Xampp_restart and the Xampp_stop. The following maybe useful if you wish to tweak the system further. Please be careful.

(1) The MySQL server can be started by double-clicking (executing) mysql_start.bat. This file can be found in the same folder you installed xampp in, most likely this will be C:\xampplite\. The exact path to this file is X:\xampplite\mysql_start.bat, where "X" indicates the letter of the drive you unpacked xampp into.This batch file starts the MySQL server in console mode. The first intialization might take a few minutes.

Do not close the DOS window or you'll crash the server! To stop the server, please use mysql_shutdown.bat, which is located in the same directory.

(2) To use the MySQL Daemon with "innodb" for better performance,
please edit the "my" (or "my.cnf") file in the /xampplite/mysql/bin directory or for services the c:\my.cnf for windows NT/2000/XP. In that director, activate the
"innodb_data_file_path=ibdata1:30M"
statement. Attention, "innodb" is not recommended for 95/98/ME.

:To use MySQL as Service for NT/2000/XP, simply copy the "my" / "my.cnf" file to C:\my, or C:\my.cnf. Please note that this file has to be placed in C:\ (root), other locations are not permitted. Then execute the "mysql_installservice.bat" in the mysql folder.

(3) MySQL starts with standard values for the user id and the password. The preset user id is "root", the password is "" (= no password). To access MySQL via PHP with the preset values, you'll have to use the following syntax:
mysql_connect("localhost","root","");
If you want to set a password for MySQL access, please use of mysqladmin.
To set the password "secret" for the user "root", type the following:

\xampplite\mysql\bin\mysqladmin -u root password secret

Have a lot of fun! Viel Spaß! Bonne Chance!

==See also==

*[https://docs.moodle.org/19/en/Installation_guide_-_Moodle_for_Windows_on_a_USB_Memory_Stick Installation guide - Moodle 1.9 for Windows on a USB Memory Stick]
*Return to [[Windows installation]]
*[[Windows 1 computer many servers |Multiple web servers, on 1 computer]] similar to windows installation page, with some tips
*[https://docs.moodle.org/en/Windows_installation_using_XAMPP#Troubleshooting Troubleshooting]if you are running Skype.
*[[Installing_AMP]] lots of XAMPP stuff. XAMPP stands for X (cross platform), Apache, MySQL,PHP and Perl. XAMPP used in Moodle does not include Perl. MAMP stands for Mac, Apache, MySQL and PHP.
*[[Installation Package for OS X]]

[[es:Paquetes para Instalación Completa para Windows]]
[[pl:Kompletne pakiety instalacyjne]]
[[de:Vollständiges Installationspaket für Windows]]

[[Category:Installation]]
[[Category:Windows]]

Complete install packages for Windows

2017-12-27T01:10:04Z

Stronk7: MDLSITE-4964 - phpmyadmin does not come with moodle windows installers since ages ago. Deleting any reference to it.

{{Installing Moodle}}
Complete install packages are available from Moodle.org's [https://download.moodle.org/windows/ Windows download page] and also from [https://bitnami.com/stacks Bitnami stacks]. The packages are designed for new installations on a standalone computer. All them use the popular [https://www.apachefriends.org/ XAMPP Apache Friends packages]. The complete install package can be used on a server, but '''it is not recommended that it be used as a production site'''. Please note Moodle.org's [http://download.moodle.org Standard install packages] only contain the Moodle code.

This document provides instructions for using the Windows packages. Separate instructions are available for [[Complete Install Packages for Mac OS X|Mac OS X packages]].

The complete install packages allow Moodle to be installed, along with the prerequisites that includes a web server, Apache, database, MySQL, scripting language, PHP and Moodle all wrapped in the Xampp-lite shell. Several versions of the complete install package are available. The instructions on the download page provide guidance on which version is likely to be most suitable.

In short, complete install packages are designed to create a matched webserver and Moodle site on a standalone computer with minimal effort.

==System requirements==
:*256 MB RAM (minimum), 1GB RAM (recommended)
:*500 MB free Fixed Disk (more space will be needed depending on user uploads)
:* For old versions of Moodle:
:**Windows 98/ME (minimum)
:**Windows NT/2000/XP/2003 (recommended)
:* For Moodle 3.1 and later versions:
:**Windows Vista/7/8/10/2008/2012
:**Microsoft Visual C++ 2015 Redistributable package is required for PHP ([https://www.microsoft.com/en-us/download/details.aspx?id=48145 download link)].

===Port 80 Conflict if Skype is already installed===
As the Moodle Windows package uses the same port (80) as [http://www.skype.com/en/ Skype] does, it will not work if the computer has Skype already installed.

The fix is very simple: Exit Skype (don't just close the window), then start the Moodle Windows package. Once Moodle for Windows is running, it should be safe to start Skype again. If the local Moodle is using the port 80, Skype will automatically select a different port when it is run.

===Vista and Windows 7/8/10===

Packages generated for Moodle 3.1 and later versions should work with Vista/7/8/10 out of the box. They include PHP 7 and MariaDB instead of MySQL, resulting in a smoother experience than previous versions of the packages.

People facing problems with the new packages should:

:* Read the Requirements and Troubleshooting information, both here and in the package's README.txt file.
:* Report any consistent problem in the [https://tracker.moodle.org Moodle Tracker], so it can be investigated and, hopefully, fixed.
:* Consider installing a virtual machine (eg, [https://www.virtualbox.org/ VirtualBox]) with a windows or linux LAMP stack and then install Moodle there.
:* Use other Moodle-ready alternatives [https://moodlecloud.com out there].

==Install complete package process==
The complete install package is a zip file that contains a webserver called [[Apache]], plus Moodle and Moodle's required [[MySQL]] database and [[PHP]] program.

There are three basic parts to the this install process.
#Download and unpack the complete install package.
#Start the webserver.
#Install Moodle using a web browser.

===First create file structure===
====Download the package====
[http://download.moodle.org/windows Download Windows] packed-zip file from Moodle.

====Unpack the package====
Unpack (extract files by clicking on) the zip file you downloaded to a drive or partition of your choice. The extract process will create three files ("Start Moodle", "Stop Moodle", and "README") and a subfolder called "server".
*Do NOT rename the "server" subfolder
:''Note:'' There will also be a folder under this server subfolder, called \moodle that holds the Moodle program.

:''TIP:'' Create a folder and extract the files there. For example, you might have one folder called Moodle254 and another one called Moodle281 for different versions or purposes.

:''TIP:'' Make path to "server" subfolder simple. Best way if it will be in drive root. Like "D:\moodle281\server". A long path, especially with any strange symbols, can prevent XAMPP from working properly.

:''NOTE:'' If you will be installing a server with a language other than English, the install process will need to download the corresponding language pack, which will take some time, and you will likely get a script timeout error. To prevent this, you will need to edit the server/php/php.ini file and change the line that has 'max_execution_time = 30' into 'max_execution_time = 600'.

===Second - start the webserver===
Now you are ready to start the webserver. Use the "Start Moodle.exe" file which you should find in the top directory. Once the "Start Moodle.exe" program is open, don't close it; use "Stop Moodle.exe" for that purpose.

:''Note:'' These programs control both Apache and MySQL programs that operate the webserver. Some sites will individually start and stop Apache and MySQL with the Xampp bat files found in the "server" subfolder.

:''Tip:'' Alternatively, on a standalone computer with several potential webservers that might be running, you can use the "xampp_restart.exe" file in the "server" subfolder.

:''Tip:'' You can also add shortcuts to the commands that start and stop the site in your Windows "start" menu.

Now you are ready to start the Moodle installation.

:''Warning:'' Windows XP requires the msvcr71.dll library file in order to run Xampp. Installing the [http://www.microsoft.com/downloads/details.aspx?familyid=262D25E3-F589-4842-8157-034D1E7CF3A3&displaylang=en .Net 1.1 framework] (not .Net 2.0 and upper) could resolve it. You can also search for the file on Google, download it and copy it into the server/apache/bin folder.

===Third - start Moodle installation===
Start your web browser and type <nowiki> localhost, or http://127.0.0.1 or http://localhost </nowiki>in the address bar. You will either start your first time Moodle installation or if it is already installed you will enter the Moodle site's [[Front Page]] or Login screen.

[[Image:Moodle_Setup_localhost_browser.jpg|frame|center|A browser's addressbar showing "localhost". Click on the green Goto arrow will go to the installed Moodle site.]]

:''Tip:'' After Moodle installs, put the site in your "favorites" or as a "bookmark" in you browser.

====Set language====
The initial install page will be displayed after you type "localhost".

[[Image:C Install Windows 1.png|thumb|center|600px|Set initial language]]

*Choose your preferred language (English is used in this example) and click the “Next” button.

====Diagnostic results====
A diagnostic report is displayed – hopefully it will look like this, if not you may need to address some issues.
[[Image:Complete Windows Install 2.png|thumb|center|546px|Moodle liked and gave a Pass ]]

*Click the “Next” button to continue.

====Moodle paths====
The paths for your Moodle installation are shown – if you are only using this as a local testing server, accept the ones that are shown on your screen.

What you enter in the "Web Address" field depends on what you intend to use the new Moodle installation for.
If you are just going to use it for local testing, then use 'http://localhost'.
If you are going to test the new installation on a LAN, and will be accessing it from other machines on that LAN, then put the private IP address or network name of the serving machine, followed by a forward slash and moodle: Web Address - http://192.168.1.1/moodle
If you are going to test the installation on the internet, then you will need to put the public ip address followed by a forward slash and moodle: http://your_ip_address/moodle or you can put your domain name here instead.

[[image:Complete install Windows 3.png|thumb|center|600px|Installation paths]]

*Click the “Next” button to continue.

====Database configuration====
*In the next fields, we enter the database settings. The fields are populated with some suggested values.

*We strongly recommend you place a user name and password in this screen. (Don't forget them).

*DO NOT USE THE “ROOT” USER WITHOUT A PASSWORD FOR PRODUCTION INSTALLATIONS AS THIS CREATES A SECURITY VULNERABILITY
[[image:Complete install Windows 4.png|thumb|center|535px|Installation's database settings]]

*When the fields have been populated, click the “Next” button to continue.

====Check server====
The install process checks the server it installed.
[[image:Complete install Windows 5.png|thumb|center|535px|Check server environment screen]]
*Click the “Next” button to continue.

====Confirm initial language pack====
Moodle will now check to see if the language pack is available for the language you selected at the first step. If it is not, Moodle will continue with the install in English.
[[image:Complete install Windows 6.png|thumb|center|535px|Language pack check]]

====Confirm config.php====
Provided the Moodle folder is writable, a message confirming the configuration has been completed will be displayed.
[[image:Complete install Windows 7.png|thumb|center|549px|Confirmation that config.php has been created]]

*Click the “ Continue” button to proceed.

====Moodle copyright & agreement====
The Moodle copyright / license notices are displayed.

[[image:Complete install Windows 8.png|thumb|center|400px|Copyright notice and agreement]]

*Click the “Yes” button to continue.

====Current release and unattended option====
The current release information is shown.
'''Check off the unattended operations box'''. This will automatically advance through many screens. If you would like to watch the install screen by screen, do not check this box and be prepared to press the "continute button" many times.

*Click the "Continue" button and wait.
[[Image:Complete install Windows 9.png|thumb|center|600px|Current release and "unattended" check box]]

====Installation modules and blocks screens====
In most cases this will be followed by a series of screens that have a continue button on the bottom. This process stops with Admin user profile settings which needs to be filled out.

====Administrator user profile====
[[Image:Complete install Windows 10.png|thumb|center|The administrator's users profile screen]]

Fill out the required fields.
*Click on "Save" to continue

====Front page settings====
The next screen is the Front Page settings page. There are two parts to it.
The first part will ask for your Full site name and a short name for the navigation bar. There is also a place for a description. You can change these later.

[[Image:Complete install Windows 11a.png|thumb|center|The Moodle sites [[Front Page]] information]]

The second part on the bottom instructs Moodle if you will disable the new user self [[Authentication|authentication]] through email process. The default is to disable. This can be changed later in the [[Site administration block|site administration block]].

[[Image:Complete install Windows 11ba.png|thumb|center|500px|Determine if users can create their own profiles when they log onto the side via email self authentication]]

*Click on "Save changes" button to go to Moodle sites home page.

====Moodle on====
'''Now you are ready to Moodle !'''

[[Image:Complete install Windows 12.png|thumb|center|Blank Front page of your new site]]

The Site Administration block is on the left, the "Turn edit on" button in the upper right corner, withe the site description block just below it.

===Congratulations - Moodle has been installed===
This finishes the installation of a complete package. Type <nowiki>http://localhost</nowiki> (or what ever you set for web address earlier in the setup!) in your browser and Moodle will open.

Your next task will be to configure Moodle to meet your needs. Don't worry, it is easy to change any of the settings now that Moodle is up and running.
*Check ''Settings > Site administration'' for further links.

==More tips and cautions==
*For installation on a Windows 2000 or Windows 2003 production server it is good practice to perform a manual install (see the manual installation section in [[Windows_installation|Windows Installation]]).

*After installing the Windows package, you may wish to add additional contributed modules and plugins. Theset may involve more customization of configuration files.

*The latest complete install package version components, may not be backwardly compatible. Always check version compatibility of each component if you intend to develop materials on a later version of Moodle than the version installed on your "main" Moodle site. In short, complete install packages are designed for first time install on a "clean" machine.

== Security matters (A MUST READ!)==

As mentioned before, XAMPP is not meant for production use but only for developers
in a development environment. The way XAMPP is configured is to be open as possible
and allowing the developer anything he/she wants. For development environments this
is great but in a production environment it could be fatal. Here a list of missing security
in XAMPP:

The MySQL administrator (root) has no password.
The MySQL daemon is accessible via network.
Examples are accessible via network.

To fix most of the security weaknesses simply call the following URL:

<nowiki>http://localhost/security/</nowiki>

The root password for MySQL and also a XAMPP directory protection can be established here.

Note that on the Windows installer package, some (all?) of these issues have been fixed already by default and the above link does not work.

If in doubt, more info is [http://www.apachefriends.org/en/faq-xampp-windows.html here]

== Apache and MySQL tweaks ==
Most of the time it is not necessary to tweak Apache or MySQL after completing the complete install package. Nor is it necessary to individually start and stop them because that is what the Xampp_start, Xampp_restart and Xammp_stop files are for.

=== Installing Apache and MySQL as services===
(This is only for NT4 | Windows 2000 | Windows XP operating systems)

\xampplite\apache\apache_installservice.bat =
==> Install Apache 2 as service

\xampplite\apache\apache_uninstallservice.bat =
==> Uninstall Apache 2 as service

\xampplite\mysql\mysql_installservice.bat =
==> Install MySQL as service

\xampplite\mysql\mysql_uninstallservice.bat =
==> Uninstall MySQL as service

==> After all Service (un)installations, please restart your system!

===Apache Notes===

You can use the apache_start and apache_stop bat files to start and stop apache from running. However the Xampp_start or Xampp_restart and Xampp_stop is recommended to turn on/off both Apache and MySQL.

====Troubleshooting====

If you find that Apache is very flaky, with the page often not loading properly or even at all (especially on localhost), try adding these lines to the end of C:\your_moodle_installer_directory\apache\conf\httpd.conf

EnableSendfile Off
EnableMMAP Off
Win32DisableAcceptEx

If You edit some .php files but browser still show old state of them, try to disable eAccelerator extension in \server\php\php.ini

[eAccelerator]
;extension=eaccelerator.dll

===MySQL notes===
Again, the recommendation to start and stop the entire webserver is to use the xampp_start or Xampp_restart and the Xampp_stop. The following maybe useful if you wish to tweak the system further. Please be careful.

(1) The MySQL server can be started by double-clicking (executing) mysql_start.bat. This file can be found in the same folder you installed xampp in, most likely this will be C:\xampplite\. The exact path to this file is X:\xampplite\mysql_start.bat, where "X" indicates the letter of the drive you unpacked xampp into.This batch file starts the MySQL server in console mode. The first intialization might take a few minutes.

Do not close the DOS window or you'll crash the server! To stop the server, please use mysql_shutdown.bat, which is located in the same directory.

(2) To use the MySQL Daemon with "innodb" for better performance,
please edit the "my" (or "my.cnf") file in the /xampplite/mysql/bin directory or for services the c:\my.cnf for windows NT/2000/XP. In that director, activate the
"innodb_data_file_path=ibdata1:30M"
statement. Attention, "innodb" is not recommended for 95/98/ME.

:To use MySQL as Service for NT/2000/XP, simply copy the "my" / "my.cnf" file to C:\my, or C:\my.cnf. Please note that this file has to be placed in C:\ (root), other locations are not permitted. Then execute the "mysql_installservice.bat" in the mysql folder.

(3) MySQL starts with standard values for the user id and the password. The preset user id is "root", the password is "" (= no password). To access MySQL via PHP with the preset values, you'll have to use the following syntax:
mysql_connect("localhost","root","");
If you want to set a password for MySQL access, please use of mysqladmin.
To set the password "secret" for the user "root", type the following:

\xampplite\mysql\bin\mysqladmin -u root password secret

Have a lot of fun! Viel Spaß! Bonne Chance!

==See also==

*[https://docs.moodle.org/19/en/Installation_guide_-_Moodle_for_Windows_on_a_USB_Memory_Stick Installation guide - Moodle 1.9 for Windows on a USB Memory Stick]
*Return to [[Windows installation]]
*[[Windows 1 computer many servers |Multiple web servers, on 1 computer]] similar to windows installation page, with some tips
*[https://docs.moodle.org/en/Windows_installation_using_XAMPP#Troubleshooting Troubleshooting]if you are running Skype.
*[[Installing_AMP]] lots of XAMPP stuff. XAMPP stands for X (cross platform), Apache, MySQL,PHP and Perl. XAMPP used in Moodle does not include Perl. MAMP stands for Mac, Apache, MySQL and PHP.
*[[Installation Package for OS X]]

[[es:Paquetes para Instalación Completa para Windows]]
[[pl:Kompletne pakiety instalacyjne]]
[[de:Vollständiges Installationspaket für Windows]]

[[Category:Installation]]
[[Category:Windows]]

admin/environment/custom check/site not https

2017-04-17T14:33:52Z

Stronk7: Stronk7 moved page admin/environment/custom check/check is https to admin/environment/custom check/site not https without leaving a redirect: because I've changed the name of the environment check in MDL-54901

#Redirect[[Transitioning to HTTPS]]

[[es:HTTPS]]

admin/environment/custom check/site not https

2017-04-17T12:10:52Z

Stronk7: WIP on https://tracker.moodle.org/browse/MDL-54901 ...

#Redirect[[Transitioning to HTTPS]]

[[es:HTTPS]]

admin/environment/custom check/check ssl wwwroot

2017-04-17T11:57:34Z

Stronk7: I really think that HTTPS was a better target, but as far as we have wgMaxRedirects = 1, cannot get multiple redirects working, it seems. So straight redirecting here.

#Redirect[[Transitioning to HTTPS]]

[[es:HTTPS]]

admin/environment/custom check/check ssl wwwroot

2017-04-17T11:51:19Z

Stronk7: Working on MDL-54901 ... testing ...

#Redirect[[HTTPS]]

[[es:HTTPS]]

Complete install packages for Windows

2016-09-27T10:08:25Z

Stronk7: /* Vista and Windows 7/8/10 */

{{Installing Moodle}}
Complete install packages are available from Moodle.org's [https://download.moodle.org/windows/ Windows download page] and also from [https://bitnami.com/stacks Bitnami stacks]. The packages are designed for new installations on a standalone computer. All them use the popular [https://www.apachefriends.org/ XAMPP Apache Friends packages]. The complete install package can be used on a server, but '''it is not recommended that it be used as a production site'''. Please note Moodle.org's [http://download.moodle.org Standard install packages] only contain the Moodle code.

This document provides instructions for using the Windows packages. Separate instructions are available for [[Complete Install Packages for Mac OS X|Mac OS X packages]].

The complete install packages allow Moodle to be installed, along with the prerequisites that includes a web server, Apache, database, MySQL, scripting language, PHP, an administration tool, phpMyAdmin and Moodle all wrapped in the Xampp-lite shell. Several versions of the complete install package are available. The instructions on the download page provide guidance on which version is likely to be most suitable.

In short, complete install packages are designed to create a matched webserver and Moodle site on a standalone computer with minimal effort.

==System requirements==
:*256 MB RAM (minimum), 1GB RAM (recommended)
:*500 MB free Fixed Disk (more space will be needed depending on user uploads)
:* For old versions of Moodle:
:**Windows 98/ME (minimum)
:**Windows NT/2000/XP/2003 (recommended)
:* For Moodle 3.1 and later versions:
:**Windows Vista/7/8/10/2008/2012
:**Microsoft Visual C++ 2015 Redistributable package is required for PHP ([https://www.microsoft.com/en-us/download/details.aspx?id=48145 download link)].

===Port 80 Conflict if Skype is already installed===
As the Moodle Windows package uses the same port (80) as [http://www.skype.com/en/ Skype] does, it will not work if the computer has Skype already installed.

The fix is very simple: Exit Skype (don't just close the window), then start the Moodle Windows package. Once Moodle for Windows is running, it should be safe to start Skype again. If the local Moodle is using the port 80, Skype will automatically select a different port when it is run.

===Vista and Windows 7/8/10===
{{New features}}

Packages generated for Moodle 3.1 and later versions should work with Vista/7/8/10 out of the box. They include PHP 7 and MariaDB instead of MySQL, resulting in a smoother experience than previous versions of the packages.

People facing problems with the new packages should:

:* Read the Requirements and Troubleshooting information, both here and in the package's README.txt file.
:* Report any consistent problem in the [https://tracker.moodle.org Moodle Tracker], so it can be investigated and, hopefully, fixed.
:* Consider installing a virtual machine (eg, [https://www.virtualbox.org/ VirtualBox]) with a windows or linux LAMP stack and then install Moodle there.
:* Use other Moodle-ready alternatives [https://moodlecloud.com out there].

==Install complete package process==
The complete install package is a zip file that contains a webserver called [[Apache]], plus Moodle and Moodle's required [[MySQL]] database and [[PHP]] program.

There are three basic parts to the this install process.
#Download and unpack the complete install package.
#Start the webserver.
#Install Moodle using a web browser.

===First create file structure===
====Download the package====
[http://download.moodle.org/windows Download Windows] packed-zip file from Moodle.
[[Image:Moodle Setup zipfile.jpg|frame|center|A downloaded complete install package Windows 1.9 zip file in Windows Explorer]]

====Unpack the package====
Unpack (extract files by clicking on) the zip file you downloaded to a drive or partition of your choice. The extract process will create three files ("Start Moodle", "Stop Moodle", and "README") and a subfolder called "server".
*Do NOT rename the "server" subfolder
:''Note:'' There will also be a folder under this server subfolder, called \moodle that holds the Moodle program.

:''TIP:'' Create a folder and extract the files there. For example, you might have one folder called Moodle254 and another one called Moodle281 for different versions or purposes.

:''TIP:'' Make path to "server" subfolder simple. Best way if it will be in drive root. Like "D:\moodle281\server". A long path, especially with any strange symbols, can prevent XAMPP from working properly.

===Second - start the webserver===
Now you are ready to start the webserver. Use the "Start Moodle.exe" file which you should find in the top directory. Once the "Start Moodle.exe" program is open, don't close it; use "Stop Moodle.exe" for that purpose.

:''Note:'' These programs control both Apache and MySQL programs that operate the webserver. Some sites will individually start and stop Apache and MySQL with the Xampp bat files found in the "server" subfolder.

:''Tip:'' Alternatively, on a standalone computer with several potential webservers that might be running, you can use the "xampp_restart.exe" file in the "server" subfolder.

:''Tip:'' You can also add shortcuts to the commands that start and stop the site in your Windows "start" menu.

Now you are ready to start the Moodle installation.

:''Warning:'' Windows XP requires the msvcr71.dll library file in order to run Xampp. Installing the [http://www.microsoft.com/downloads/details.aspx?familyid=262D25E3-F589-4842-8157-034D1E7CF3A3&displaylang=en .Net 1.1 framework] (not .Net 2.0 and upper) could resolve it. You can also search for the file on Google, download it and copy it into the server/apache/bin folder.

===Third - start Moodle installation===
Start your web browser and type <nowiki> localhost, or http://127.0.0.1 or http://localhost </nowiki>in the address bar. You will either start your first time Moodle installation or if it is already installed you will enter the Moodle site's [[Front Page]] or Login screen.

[[Image:Moodle_Setup_localhost_browser.jpg|frame|center|A browser's addressbar showing "localhost". Click on the green Goto arrow will go to the installed Moodle site.]]

:''Tip:'' After Moodle installs, put the site in your "favorites" or as a "bookmark" in you browser.

====Set language====
The initial install page will be displayed after you type "localhost".

[[Image:C Install Windows 1.png|thumb|center|600px|Set initial language]]

*Choose your preferred language (English is used in this example) and click the “Next” button.

====Diagnostic results====
A diagnostic report is displayed – hopefully it will look like this, if not you may need to address some issues.
[[Image:Complete Windows Install 2.png|thumb|center|546px|Moodle liked and gave a Pass ]]

*Click the “Next” button to continue.

====Moodle paths====
The paths for your Moodle installation are shown – if you are only using this as a local testing server, accept the ones that are shown on your screen.

What you enter in the "Web Address" field depends on what you intend to use the new Moodle installation for.
If you are just going to use it for local testing, then use 'http://localhost'.
If you are going to test the new installation on a LAN, and will be accessing it from other machines on that LAN, then put the private IP address or network name of the serving machine, followed by a forward slash and moodle: Web Address - http://192.168.1.1/moodle
If you are going to test the installation on the internet, then you will need to put the public ip address followed by a forward slash and moodle: http://your_ip_address/moodle or you can put your domain name here instead.

[[image:Complete install Windows 3.png|thumb|center|600px|Installation paths]]

*Click the “Next” button to continue.

====Database configuration====
*In the next fields, we enter the database settings. The fields are populated with some suggested values.

*We strongly recommend you place a user name and password in this screen. (Don't forget them).

*DO NOT USE THE “ROOT” USER WITHOUT A PASSWORD FOR PRODUCTION INSTALLATIONS AS THIS CREATES A SECURITY VULNERABILITY
[[image:Complete install Windows 4.png|thumb|center|535px|Installation's database settings]]

*When the fields have been populated, click the “Next” button to continue.

====Check server====
The install process checks the server it installed.
[[image:Complete install Windows 5.png|thumb|center|535px|Check server environment screen]]
*Click the “Next” button to continue.

====Confirm initial language pack====
Moodle will now check to see if the language pack is available for the language you selected at the first step. If it is not, Moodle will continue with the install in English.
[[image:Complete install Windows 6.png|thumb|center|535px|Language pack check]]

====Confirm config.php====
Provided the Moodle folder is writable, a message confirming the configuration has been completed will be displayed.
[[image:Complete install Windows 7.png|thumb|center|549px|Confirmation that config.php has been created]]

*Click the “ Continue” button to proceed.

====Moodle copyright & agreement====
The Moodle copyright / license notices are displayed.

[[image:Complete install Windows 8.png|thumb|center|400px|Copyright notice and agreement]]

*Click the “Yes” button to continue.

====Current release and unattended option====
The current release information is shown.
'''Check off the unattended operations box'''. This will automatically advance through many screens. If you would like to watch the install screen by screen, do not check this box and be prepared to press the "continute button" many times.

*Click the "Continue" button and wait.
[[Image:Complete install Windows 9.png|thumb|center|600px|Current release and "unattended" check box]]

====Installation modules and blocks screens====
In most cases this will be followed by a series of screens that have a continue button on the bottom. This process stops with Admin user profile settings which needs to be filled out.

====Administrator user profile====
[[Image:Complete install Windows 10.png|thumb|center|The administrator's users profile screen]]

Fill out the required fields.
*Click on "Save" to continue

====Front page settings====
The next screen is the Front Page settings page. There are two parts to it.
The first part will ask for your Full site name and a short name for the navigation bar. There is also a place for a description. You can change these later.

[[Image:Complete install Windows 11a.png|thumb|center|The Moodle sites [[Front Page]] information]]

The second part on the bottom instructs Moodle if you will disable the new user self [[authentication]] through email process. The default is to disable. This can be changed later in the [[Site administration block|site administration block]].

[[Image:Complete install Windows 11ba.png|thumb|center|500px|Determine if users can create their own profiles when they log onto the side via email self authentication]]

*Click on "Save changes" button to go to Moodle sites home page.

====Moodle on====
'''Now you are ready to Moodle !'''

[[Image:Complete install Windows 12.png|thumb|center|Blank Front page of your new site]]

The Site Administration block is on the left, the "Turn edit on" button in the upper right corner, withe the site description block just below it.

===Congratulations - Moodle has been installed===
This finishes the installation of a complete package. Type <nowiki>http://localhost</nowiki> (or what ever you set for web address earlier in the setup!) in your browser and Moodle will open.

Your next task will be to configure Moodle to meet your needs. Don't worry, it is easy to change any of the settings now that Moodle is up and running.
*Check ''Settings > Site administration'' for further links.

==More tips and cautions==
*For installation on a Windows 2000 or Windows 2003 production server it is good practice to perform a manual install (see the manual installation section in [[Windows_installation|Windows Installation]]).

*After installing the Windows package, you may wish to add additional contributed modules and plugins. Theset may involve more customization of configuration files.

*The latest complete install package version components, may not be backwardly compatible. Always check version compatibility of each component if you intend to develop materials on a later version of Moodle than the version installed on your "main" Moodle site. In short, complete install packages are designed for first time install on a "clean" machine.

== Security matters (A MUST READ!)==

As mentioned before, XAMPP is not meant for production use but only for developers
in a development environment. The way XAMPP is configured is to be open as possible
and allowing the developer anything he/she wants. For development environments this
is great but in a production environment it could be fatal. Here a list of missing security
in XAMPP:

The MySQL administrator (root) has no password.
The MySQL daemon is accessible via network.
phpMyAdmin is accessible via network.
Examples are accessible via network.

To fix most of the security weaknesses simply call the following URL:

<nowiki>http://localhost/security/</nowiki>

The root password for MySQL + phpMyAdmin and also a XAMPP directory protection can be established here.

Note that on the Windows installer package, some (all?) of these issues have been fixed already by default and the above link does not work.

If in doubt, more info is [http://www.apachefriends.org/en/faq-xampp-windows.html here]

== Apache and MySQL tweaks ==
Most of the time it is not necessary to tweak Apache or MySQL after completing the complete install package. Nor is it necessary to individually start and stop them because that is what the Xampp_start, Xampp_restart and Xammp_stop files are for.

=== Installing Apache and MySQL as services===
(This is only for NT4 | Windows 2000 | Windows XP operating systems)

\xampplite\apache\apache_installservice.bat =
==> Install Apache 2 as service

\xampplite\apache\apache_uninstallservice.bat =
==> Uninstall Apache 2 as service

\xampplite\mysql\mysql_installservice.bat =
==> Install MySQL as service

\xampplite\mysql\mysql_uninstallservice.bat =
==> Uninstall MySQL as service

==> After all Service (un)installations, please restart your system!

===Apache Notes===

You can use the apache_start and apache_stop bat files to start and stop apache from running. However the Xampp_start or Xampp_restart and Xampp_stop is recommended to turn on/off both Apache and MySQL.

====Troubleshooting====

If you find that Apache is very flaky, with the page often not loading properly or even at all (especially on localhost), try adding these lines to the end of C:\your_moodle_installer_directory\apache\conf\httpd.conf

EnableSendfile Off
EnableMMAP Off
Win32DisableAcceptEx

If You edit some .php files but browser still show old state of them, try to disable eAccelerator extension in \server\php\php.ini

[eAccelerator]
;extension=eaccelerator.dll

===MySQL notes===
Again, the recommendation to start and stop the entire webserver is to use the xampp_start or Xampp_restart and the Xampp_stop. The following maybe useful if you wish to tweak the system further. Please be careful.

(1) The MySQL server can be started by double-clicking (executing) mysql_start.bat. This file can be found in the same folder you installed xampp in, most likely this will be C:\xampplite\. The exact path to this file is X:\xampplite\mysql_start.bat, where "X" indicates the letter of the drive you unpacked xampp into.This batch file starts the MySQL server in console mode. The first intialization might take a few minutes.

Do not close the DOS window or you'll crash the server! To stop the server, please use mysql_shutdown.bat, which is located in the same directory.

(2) To use the MySQL Daemon with "innodb" for better performance,
please edit the "my" (or "my.cnf") file in the /xampplite/mysql/bin directory or for services the c:\my.cnf for windows NT/2000/XP. In that director, activate the
"innodb_data_file_path=ibdata1:30M"
statement. Attention, "innodb" is not recommended for 95/98/ME.

:To use MySQL as Service for NT/2000/XP, simply copy the "my" / "my.cnf" file to C:\my, or C:\my.cnf. Please note that this file has to be placed in C:\ (root), other locations are not permitted. Then execute the "mysql_installservice.bat" in the mysql folder.

(3) MySQL starts with standard values for the user id and the password. The preset user id is "root", the password is "" (= no password). To access MySQL via PHP with the preset values, you'll have to use the following syntax:
mysql_connect("localhost","root","");
If you want to set a password for MySQL access, please use of mysqladmin.
To set the password "secret" for the user "root", type the following:

\xampplite\mysql\bin\mysqladmin -u root password secret

After changing the password you'll have to reconfigure phpMyAdmin to use the new password, otherwise it won't be able to access the databases. To do that, open the file config.inc.php in \xampplite\phpmyadmin\ and edit the following lines:

$cfg['Servers'][$i]['user'] = 'root'; // MySQL user
$cfg['Servers'][$i]['auth_type'] = 'http'; // HTTP authentificate

So first the 'root' password is queried by the MySQL server, before phpMyAdmin may access.

Have a lot of fun! Viel Spaß! Bonne Chance!

==See also==

*[https://docs.moodle.org/19/en/Installation_guide_-_Moodle_for_Windows_on_a_USB_Memory_Stick Installation guide - Moodle 1.9 for Windows on a USB Memory Stick]
*Return to [[Windows installation]]
*[[Windows 1 computer many servers |Multiple web servers, on 1 computer]] similar to windows installation page, with some tips
*[https://docs.moodle.org/en/Windows_installation_using_XAMPP#Troubleshooting Troubleshooting]if you are running Skype.
*[[Installing_AMP]] lots of XAMPP stuff. XAMPP stands for X (cross platform), Apache, MySQL,PHP and Perl. XAMPP used in Moodle does not include Perl. MAMP stands for Mac, Apache, MySQL and PHP.
*[[Installation Package for OS X]]

[[es:Paquetes para Instalación Completa para Windows]]
[[pl:Kompletne pakiety instalacyjne]]
[[de:Vollständiges Installationspaket für Windows]]

[[Category:Installation]]
[[Category:Windows]]

Complete install packages for Windows

2016-09-27T09:48:17Z

Stronk7: /* Vista and Windows 7/8/10 */

{{Installing Moodle}}
Complete install packages are available from Moodle.org's [https://download.moodle.org/windows/ Windows download page] and also from [https://bitnami.com/stacks Bitnami stacks]. The packages are designed for new installations on a standalone computer. All them use the popular [https://www.apachefriends.org/ XAMPP Apache Friends packages]. The complete install package can be used on a server, but '''it is not recommended that it be used as a production site'''. Please note Moodle.org's [http://download.moodle.org Standard install packages] only contain the Moodle code.

This document provides instructions for using the Windows packages. Separate instructions are available for [[Complete Install Packages for Mac OS X|Mac OS X packages]].

The complete install packages allow Moodle to be installed, along with the prerequisites that includes a web server, Apache, database, MySQL, scripting language, PHP, an administration tool, phpMyAdmin and Moodle all wrapped in the Xampp-lite shell. Several versions of the complete install package are available. The instructions on the download page provide guidance on which version is likely to be most suitable.

In short, complete install packages are designed to create a matched webserver and Moodle site on a standalone computer with minimal effort.

==System requirements==
:*256 MB RAM (minimum), 1GB RAM (recommended)
:*500 MB free Fixed Disk (more space will be needed depending on user uploads)
:* For old versions of Moodle:
:**Windows 98/ME (minimum)
:**Windows NT/2000/XP/2003 (recommended)
:* For Moodle 3.1 and later versions:
:**Windows Vista/7/8/10/2008/2012
:**Microsoft Visual C++ 2015 Redistributable package is required for PHP ([https://www.microsoft.com/en-us/download/details.aspx?id=48145 download link)].

===Port 80 Conflict if Skype is already installed===
As the Moodle Windows package uses the same port (80) as [http://www.skype.com/en/ Skype] does, it will not work if the computer has Skype already installed.

The fix is very simple: Exit Skype (don't just close the window), then start the Moodle Windows package. Once Moodle for Windows is running, it should be safe to start Skype again. If the local Moodle is using the port 80, Skype will automatically select a different port when it is run.

===Vista and Windows 7/8/10===
{{Moodle 3.1}}

Packages generated for Moodle 3.1 and later versions should work with Vista/7/8/10 out of the box. They include PHP 7 and MariaDB instead of MySQL, resulting in a smoother experience than previous versions of the packages.

People facing problems with the new packages should:

:* Read the Requirements and Troubleshooting information, both here and in the package's README.txt file.
:* Report any consistent problem in the [https://tracker.moodle.org Moodle Tracker], so it can be investigated and, hopefully, fixed.
:* Consider installing a virtual machine (eg, [https://www.virtualbox.org/ VirtualBox]) with a windows or linux LAMP stack and then install Moodle there.
:* Use other Moodle-ready alternatives [https://moodlecloud.com out there].

==Install complete package process==
The complete install package is a zip file that contains a webserver called [[Apache]], plus Moodle and Moodle's required [[MySQL]] database and [[PHP]] program.

There are three basic parts to the this install process.
#Download and unpack the complete install package.
#Start the webserver.
#Install Moodle using a web browser.

===First create file structure===
====Download the package====
[http://download.moodle.org/windows Download Windows] packed-zip file from Moodle.
[[Image:Moodle Setup zipfile.jpg|frame|center|A downloaded complete install package Windows 1.9 zip file in Windows Explorer]]

====Unpack the package====
Unpack (extract files by clicking on) the zip file you downloaded to a drive or partition of your choice. The extract process will create three files ("Start Moodle", "Stop Moodle", and "README") and a subfolder called "server".
*Do NOT rename the "server" subfolder
:''Note:'' There will also be a folder under this server subfolder, called \moodle that holds the Moodle program.

:''TIP:'' Create a folder and extract the files there. For example, you might have one folder called Moodle254 and another one called Moodle281 for different versions or purposes.

:''TIP:'' Make path to "server" subfolder simple. Best way if it will be in drive root. Like "D:\moodle281\server". A long path, especially with any strange symbols, can prevent XAMPP from working properly.

===Second - start the webserver===
Now you are ready to start the webserver. Use the "Start Moodle.exe" file which you should find in the top directory. Once the "Start Moodle.exe" program is open, don't close it; use "Stop Moodle.exe" for that purpose.

:''Note:'' These programs control both Apache and MySQL programs that operate the webserver. Some sites will individually start and stop Apache and MySQL with the Xampp bat files found in the "server" subfolder.

:''Tip:'' Alternatively, on a standalone computer with several potential webservers that might be running, you can use the "xampp_restart.exe" file in the "server" subfolder.

:''Tip:'' You can also add shortcuts to the commands that start and stop the site in your Windows "start" menu.

Now you are ready to start the Moodle installation.

:''Warning:'' Windows XP requires the msvcr71.dll library file in order to run Xampp. Installing the [http://www.microsoft.com/downloads/details.aspx?familyid=262D25E3-F589-4842-8157-034D1E7CF3A3&displaylang=en .Net 1.1 framework] (not .Net 2.0 and upper) could resolve it. You can also search for the file on Google, download it and copy it into the server/apache/bin folder.

===Third - start Moodle installation===
Start your web browser and type <nowiki> localhost, or http://127.0.0.1 or http://localhost </nowiki>in the address bar. You will either start your first time Moodle installation or if it is already installed you will enter the Moodle site's [[Front Page]] or Login screen.

[[Image:Moodle_Setup_localhost_browser.jpg|frame|center|A browser's addressbar showing "localhost". Click on the green Goto arrow will go to the installed Moodle site.]]

:''Tip:'' After Moodle installs, put the site in your "favorites" or as a "bookmark" in you browser.

====Set language====
The initial install page will be displayed after you type "localhost".

[[Image:C Install Windows 1.png|thumb|center|600px|Set initial language]]

*Choose your preferred language (English is used in this example) and click the “Next” button.

====Diagnostic results====
A diagnostic report is displayed – hopefully it will look like this, if not you may need to address some issues.
[[Image:Complete Windows Install 2.png|thumb|center|546px|Moodle liked and gave a Pass ]]

*Click the “Next” button to continue.

====Moodle paths====
The paths for your Moodle installation are shown – if you are only using this as a local testing server, accept the ones that are shown on your screen.

What you enter in the "Web Address" field depends on what you intend to use the new Moodle installation for.
If you are just going to use it for local testing, then use 'http://localhost'.
If you are going to test the new installation on a LAN, and will be accessing it from other machines on that LAN, then put the private IP address or network name of the serving machine, followed by a forward slash and moodle: Web Address - http://192.168.1.1/moodle
If you are going to test the installation on the internet, then you will need to put the public ip address followed by a forward slash and moodle: http://your_ip_address/moodle or you can put your domain name here instead.

[[image:Complete install Windows 3.png|thumb|center|600px|Installation paths]]

*Click the “Next” button to continue.

====Database configuration====
*In the next fields, we enter the database settings. The fields are populated with some suggested values.

*We strongly recommend you place a user name and password in this screen. (Don't forget them).

*DO NOT USE THE “ROOT” USER WITHOUT A PASSWORD FOR PRODUCTION INSTALLATIONS AS THIS CREATES A SECURITY VULNERABILITY
[[image:Complete install Windows 4.png|thumb|center|535px|Installation's database settings]]

*When the fields have been populated, click the “Next” button to continue.

====Check server====
The install process checks the server it installed.
[[image:Complete install Windows 5.png|thumb|center|535px|Check server environment screen]]
*Click the “Next” button to continue.

====Confirm initial language pack====
Moodle will now check to see if the language pack is available for the language you selected at the first step. If it is not, Moodle will continue with the install in English.
[[image:Complete install Windows 6.png|thumb|center|535px|Language pack check]]

====Confirm config.php====
Provided the Moodle folder is writable, a message confirming the configuration has been completed will be displayed.
[[image:Complete install Windows 7.png|thumb|center|549px|Confirmation that config.php has been created]]

*Click the “ Continue” button to proceed.

====Moodle copyright & agreement====
The Moodle copyright / license notices are displayed.

[[image:Complete install Windows 8.png|thumb|center|400px|Copyright notice and agreement]]

*Click the “Yes” button to continue.

====Current release and unattended option====
The current release information is shown.
'''Check off the unattended operations box'''. This will automatically advance through many screens. If you would like to watch the install screen by screen, do not check this box and be prepared to press the "continute button" many times.

*Click the "Continue" button and wait.
[[Image:Complete install Windows 9.png|thumb|center|600px|Current release and "unattended" check box]]

====Installation modules and blocks screens====
In most cases this will be followed by a series of screens that have a continue button on the bottom. This process stops with Admin user profile settings which needs to be filled out.

====Administrator user profile====
[[Image:Complete install Windows 10.png|thumb|center|The administrator's users profile screen]]

Fill out the required fields.
*Click on "Save" to continue

====Front page settings====
The next screen is the Front Page settings page. There are two parts to it.
The first part will ask for your Full site name and a short name for the navigation bar. There is also a place for a description. You can change these later.

[[Image:Complete install Windows 11a.png|thumb|center|The Moodle sites [[Front Page]] information]]

The second part on the bottom instructs Moodle if you will disable the new user self [[authentication]] through email process. The default is to disable. This can be changed later in the [[Site administration block|site administration block]].

[[Image:Complete install Windows 11ba.png|thumb|center|500px|Determine if users can create their own profiles when they log onto the side via email self authentication]]

*Click on "Save changes" button to go to Moodle sites home page.

====Moodle on====
'''Now you are ready to Moodle !'''

[[Image:Complete install Windows 12.png|thumb|center|Blank Front page of your new site]]

The Site Administration block is on the left, the "Turn edit on" button in the upper right corner, withe the site description block just below it.

===Congratulations - Moodle has been installed===
This finishes the installation of a complete package. Type <nowiki>http://localhost</nowiki> (or what ever you set for web address earlier in the setup!) in your browser and Moodle will open.

Your next task will be to configure Moodle to meet your needs. Don't worry, it is easy to change any of the settings now that Moodle is up and running.
*Check ''Settings > Site administration'' for further links.

==More tips and cautions==
*For installation on a Windows 2000 or Windows 2003 production server it is good practice to perform a manual install (see the manual installation section in [[Windows_installation|Windows Installation]]).

*After installing the Windows package, you may wish to add additional contributed modules and plugins. Theset may involve more customization of configuration files.

*The latest complete install package version components, may not be backwardly compatible. Always check version compatibility of each component if you intend to develop materials on a later version of Moodle than the version installed on your "main" Moodle site. In short, complete install packages are designed for first time install on a "clean" machine.

== Security matters (A MUST READ!)==

As mentioned before, XAMPP is not meant for production use but only for developers
in a development environment. The way XAMPP is configured is to be open as possible
and allowing the developer anything he/she wants. For development environments this
is great but in a production environment it could be fatal. Here a list of missing security
in XAMPP:

The MySQL administrator (root) has no password.
The MySQL daemon is accessible via network.
phpMyAdmin is accessible via network.
Examples are accessible via network.

To fix most of the security weaknesses simply call the following URL:

<nowiki>http://localhost/security/</nowiki>

The root password for MySQL + phpMyAdmin and also a XAMPP directory protection can be established here.

Note that on the Windows installer package, some (all?) of these issues have been fixed already by default and the above link does not work.

If in doubt, more info is [http://www.apachefriends.org/en/faq-xampp-windows.html here]

== Apache and MySQL tweaks ==
Most of the time it is not necessary to tweak Apache or MySQL after completing the complete install package. Nor is it necessary to individually start and stop them because that is what the Xampp_start, Xampp_restart and Xammp_stop files are for.

=== Installing Apache and MySQL as services===
(This is only for NT4 | Windows 2000 | Windows XP operating systems)

\xampplite\apache\apache_installservice.bat =
==> Install Apache 2 as service

\xampplite\apache\apache_uninstallservice.bat =
==> Uninstall Apache 2 as service

\xampplite\mysql\mysql_installservice.bat =
==> Install MySQL as service

\xampplite\mysql\mysql_uninstallservice.bat =
==> Uninstall MySQL as service

==> After all Service (un)installations, please restart your system!

===Apache Notes===

You can use the apache_start and apache_stop bat files to start and stop apache from running. However the Xampp_start or Xampp_restart and Xampp_stop is recommended to turn on/off both Apache and MySQL.

====Troubleshooting====

If you find that Apache is very flaky, with the page often not loading properly or even at all (especially on localhost), try adding these lines to the end of C:\your_moodle_installer_directory\apache\conf\httpd.conf

EnableSendfile Off
EnableMMAP Off
Win32DisableAcceptEx

If You edit some .php files but browser still show old state of them, try to disable eAccelerator extension in \server\php\php.ini

[eAccelerator]
;extension=eaccelerator.dll

===MySQL notes===
Again, the recommendation to start and stop the entire webserver is to use the xampp_start or Xampp_restart and the Xampp_stop. The following maybe useful if you wish to tweak the system further. Please be careful.

(1) The MySQL server can be started by double-clicking (executing) mysql_start.bat. This file can be found in the same folder you installed xampp in, most likely this will be C:\xampplite\. The exact path to this file is X:\xampplite\mysql_start.bat, where "X" indicates the letter of the drive you unpacked xampp into.This batch file starts the MySQL server in console mode. The first intialization might take a few minutes.

Do not close the DOS window or you'll crash the server! To stop the server, please use mysql_shutdown.bat, which is located in the same directory.

(2) To use the MySQL Daemon with "innodb" for better performance,
please edit the "my" (or "my.cnf") file in the /xampplite/mysql/bin directory or for services the c:\my.cnf for windows NT/2000/XP. In that director, activate the
"innodb_data_file_path=ibdata1:30M"
statement. Attention, "innodb" is not recommended for 95/98/ME.

:To use MySQL as Service for NT/2000/XP, simply copy the "my" / "my.cnf" file to C:\my, or C:\my.cnf. Please note that this file has to be placed in C:\ (root), other locations are not permitted. Then execute the "mysql_installservice.bat" in the mysql folder.

(3) MySQL starts with standard values for the user id and the password. The preset user id is "root", the password is "" (= no password). To access MySQL via PHP with the preset values, you'll have to use the following syntax:
mysql_connect("localhost","root","");
If you want to set a password for MySQL access, please use of mysqladmin.
To set the password "secret" for the user "root", type the following:

\xampplite\mysql\bin\mysqladmin -u root password secret

After changing the password you'll have to reconfigure phpMyAdmin to use the new password, otherwise it won't be able to access the databases. To do that, open the file config.inc.php in \xampplite\phpmyadmin\ and edit the following lines:

$cfg['Servers'][$i]['user'] = 'root'; // MySQL user
$cfg['Servers'][$i]['auth_type'] = 'http'; // HTTP authentificate

So first the 'root' password is queried by the MySQL server, before phpMyAdmin may access.

Have a lot of fun! Viel Spaß! Bonne Chance!

==See also==

*[https://docs.moodle.org/19/en/Installation_guide_-_Moodle_for_Windows_on_a_USB_Memory_Stick Installation guide - Moodle 1.9 for Windows on a USB Memory Stick]
*Return to [[Windows installation]]
*[[Windows 1 computer many servers |Multiple web servers, on 1 computer]] similar to windows installation page, with some tips
*[https://docs.moodle.org/en/Windows_installation_using_XAMPP#Troubleshooting Troubleshooting]if you are running Skype.
*[[Installing_AMP]] lots of XAMPP stuff. XAMPP stands for X (cross platform), Apache, MySQL,PHP and Perl. XAMPP used in Moodle does not include Perl. MAMP stands for Mac, Apache, MySQL and PHP.
*[[Installation Package for OS X]]

[[es:Paquetes para Instalación Completa para Windows]]
[[pl:Kompletne pakiety instalacyjne]]
[[de:Vollständiges Installationspaket für Windows]]

[[Category:Installation]]
[[Category:Windows]]

Complete install packages for Windows

2016-09-27T09:44:48Z

Stronk7: Adding some more links to apachefrieds, bitnami, moodlecloud

{{Installing Moodle}}
Complete install packages are available from Moodle.org's [https://download.moodle.org/windows/ Windows download page] and also from [https://bitnami.com/stacks Bitnami stacks]. The packages are designed for new installations on a standalone computer. All them use the popular [https://www.apachefriends.org/ XAMPP Apache Friends packages]. The complete install package can be used on a server, but '''it is not recommended that it be used as a production site'''. Please note Moodle.org's [http://download.moodle.org Standard install packages] only contain the Moodle code.

This document provides instructions for using the Windows packages. Separate instructions are available for [[Complete Install Packages for Mac OS X|Mac OS X packages]].

The complete install packages allow Moodle to be installed, along with the prerequisites that includes a web server, Apache, database, MySQL, scripting language, PHP, an administration tool, phpMyAdmin and Moodle all wrapped in the Xampp-lite shell. Several versions of the complete install package are available. The instructions on the download page provide guidance on which version is likely to be most suitable.

In short, complete install packages are designed to create a matched webserver and Moodle site on a standalone computer with minimal effort.

==System requirements==
:*256 MB RAM (minimum), 1GB RAM (recommended)
:*500 MB free Fixed Disk (more space will be needed depending on user uploads)
:* For old versions of Moodle:
:**Windows 98/ME (minimum)
:**Windows NT/2000/XP/2003 (recommended)
:* For Moodle 3.1 and later versions:
:**Windows Vista/7/8/10/2008/2012
:**Microsoft Visual C++ 2015 Redistributable package is required for PHP ([https://www.microsoft.com/en-us/download/details.aspx?id=48145 download link)].

===Port 80 Conflict if Skype is already installed===
As the Moodle Windows package uses the same port (80) as [http://www.skype.com/en/ Skype] does, it will not work if the computer has Skype already installed.

The fix is very simple: Exit Skype (don't just close the window), then start the Moodle Windows package. Once Moodle for Windows is running, it should be safe to start Skype again. If the local Moodle is using the port 80, Skype will automatically select a different port when it is run.

===Vista and Windows 7/8/10===

Packages generated for Moodle 3.1 and later versions should work with Vista/7/8/10 out of the box. They include PHP 7 and MariaDB instead of MySQL, resulting in a smoother experience than previous versions of the packages.

People facing problems with the new packages should:

:* Read the Requirements and Troubleshooting information, both here and in the package's README.txt file.
:* Report any consistent problem in the [https://tracker.moodle.org Moodle Tracker], so it can be investigated and, hopefully, fixed.
:* Consider installing a virtual machine (eg, [https://www.virtualbox.org/ VirtualBox]) with a windows or linux LAMP stack and then install Moodle there.
:* Use other Moodle-ready alternatives [https://moodlecloud.com out there].

==Install complete package process==
The complete install package is a zip file that contains a webserver called [[Apache]], plus Moodle and Moodle's required [[MySQL]] database and [[PHP]] program.

There are three basic parts to the this install process.
#Download and unpack the complete install package.
#Start the webserver.
#Install Moodle using a web browser.

===First create file structure===
====Download the package====
[http://download.moodle.org/windows Download Windows] packed-zip file from Moodle.
[[Image:Moodle Setup zipfile.jpg|frame|center|A downloaded complete install package Windows 1.9 zip file in Windows Explorer]]

====Unpack the package====
Unpack (extract files by clicking on) the zip file you downloaded to a drive or partition of your choice. The extract process will create three files ("Start Moodle", "Stop Moodle", and "README") and a subfolder called "server".
*Do NOT rename the "server" subfolder
:''Note:'' There will also be a folder under this server subfolder, called \moodle that holds the Moodle program.

:''TIP:'' Create a folder and extract the files there. For example, you might have one folder called Moodle254 and another one called Moodle281 for different versions or purposes.

:''TIP:'' Make path to "server" subfolder simple. Best way if it will be in drive root. Like "D:\moodle281\server". A long path, especially with any strange symbols, can prevent XAMPP from working properly.

===Second - start the webserver===
Now you are ready to start the webserver. Use the "Start Moodle.exe" file which you should find in the top directory. Once the "Start Moodle.exe" program is open, don't close it; use "Stop Moodle.exe" for that purpose.

:''Note:'' These programs control both Apache and MySQL programs that operate the webserver. Some sites will individually start and stop Apache and MySQL with the Xampp bat files found in the "server" subfolder.

:''Tip:'' Alternatively, on a standalone computer with several potential webservers that might be running, you can use the "xampp_restart.exe" file in the "server" subfolder.

:''Tip:'' You can also add shortcuts to the commands that start and stop the site in your Windows "start" menu.

Now you are ready to start the Moodle installation.

:''Warning:'' Windows XP requires the msvcr71.dll library file in order to run Xampp. Installing the [http://www.microsoft.com/downloads/details.aspx?familyid=262D25E3-F589-4842-8157-034D1E7CF3A3&displaylang=en .Net 1.1 framework] (not .Net 2.0 and upper) could resolve it. You can also search for the file on Google, download it and copy it into the server/apache/bin folder.

===Third - start Moodle installation===
Start your web browser and type <nowiki> localhost, or http://127.0.0.1 or http://localhost </nowiki>in the address bar. You will either start your first time Moodle installation or if it is already installed you will enter the Moodle site's [[Front Page]] or Login screen.

[[Image:Moodle_Setup_localhost_browser.jpg|frame|center|A browser's addressbar showing "localhost". Click on the green Goto arrow will go to the installed Moodle site.]]

:''Tip:'' After Moodle installs, put the site in your "favorites" or as a "bookmark" in you browser.

====Set language====
The initial install page will be displayed after you type "localhost".

[[Image:C Install Windows 1.png|thumb|center|600px|Set initial language]]

*Choose your preferred language (English is used in this example) and click the “Next” button.

====Diagnostic results====
A diagnostic report is displayed – hopefully it will look like this, if not you may need to address some issues.
[[Image:Complete Windows Install 2.png|thumb|center|546px|Moodle liked and gave a Pass ]]

*Click the “Next” button to continue.

====Moodle paths====
The paths for your Moodle installation are shown – if you are only using this as a local testing server, accept the ones that are shown on your screen.

What you enter in the "Web Address" field depends on what you intend to use the new Moodle installation for.
If you are just going to use it for local testing, then use 'http://localhost'.
If you are going to test the new installation on a LAN, and will be accessing it from other machines on that LAN, then put the private IP address or network name of the serving machine, followed by a forward slash and moodle: Web Address - http://192.168.1.1/moodle
If you are going to test the installation on the internet, then you will need to put the public ip address followed by a forward slash and moodle: http://your_ip_address/moodle or you can put your domain name here instead.

[[image:Complete install Windows 3.png|thumb|center|600px|Installation paths]]

*Click the “Next” button to continue.

====Database configuration====
*In the next fields, we enter the database settings. The fields are populated with some suggested values.

*We strongly recommend you place a user name and password in this screen. (Don't forget them).

*DO NOT USE THE “ROOT” USER WITHOUT A PASSWORD FOR PRODUCTION INSTALLATIONS AS THIS CREATES A SECURITY VULNERABILITY
[[image:Complete install Windows 4.png|thumb|center|535px|Installation's database settings]]

*When the fields have been populated, click the “Next” button to continue.

====Check server====
The install process checks the server it installed.
[[image:Complete install Windows 5.png|thumb|center|535px|Check server environment screen]]
*Click the “Next” button to continue.

====Confirm initial language pack====
Moodle will now check to see if the language pack is available for the language you selected at the first step. If it is not, Moodle will continue with the install in English.
[[image:Complete install Windows 6.png|thumb|center|535px|Language pack check]]

====Confirm config.php====
Provided the Moodle folder is writable, a message confirming the configuration has been completed will be displayed.
[[image:Complete install Windows 7.png|thumb|center|549px|Confirmation that config.php has been created]]

*Click the “ Continue” button to proceed.

====Moodle copyright & agreement====
The Moodle copyright / license notices are displayed.

[[image:Complete install Windows 8.png|thumb|center|400px|Copyright notice and agreement]]

*Click the “Yes” button to continue.

====Current release and unattended option====
The current release information is shown.
'''Check off the unattended operations box'''. This will automatically advance through many screens. If you would like to watch the install screen by screen, do not check this box and be prepared to press the "continute button" many times.

*Click the "Continue" button and wait.
[[Image:Complete install Windows 9.png|thumb|center|600px|Current release and "unattended" check box]]

====Installation modules and blocks screens====
In most cases this will be followed by a series of screens that have a continue button on the bottom. This process stops with Admin user profile settings which needs to be filled out.

====Administrator user profile====
[[Image:Complete install Windows 10.png|thumb|center|The administrator's users profile screen]]

Fill out the required fields.
*Click on "Save" to continue

====Front page settings====
The next screen is the Front Page settings page. There are two parts to it.
The first part will ask for your Full site name and a short name for the navigation bar. There is also a place for a description. You can change these later.

[[Image:Complete install Windows 11a.png|thumb|center|The Moodle sites [[Front Page]] information]]

The second part on the bottom instructs Moodle if you will disable the new user self [[authentication]] through email process. The default is to disable. This can be changed later in the [[Site administration block|site administration block]].

[[Image:Complete install Windows 11ba.png|thumb|center|500px|Determine if users can create their own profiles when they log onto the side via email self authentication]]

*Click on "Save changes" button to go to Moodle sites home page.

====Moodle on====
'''Now you are ready to Moodle !'''

[[Image:Complete install Windows 12.png|thumb|center|Blank Front page of your new site]]

The Site Administration block is on the left, the "Turn edit on" button in the upper right corner, withe the site description block just below it.

===Congratulations - Moodle has been installed===
This finishes the installation of a complete package. Type <nowiki>http://localhost</nowiki> (or what ever you set for web address earlier in the setup!) in your browser and Moodle will open.

Your next task will be to configure Moodle to meet your needs. Don't worry, it is easy to change any of the settings now that Moodle is up and running.
*Check ''Settings > Site administration'' for further links.

==More tips and cautions==
*For installation on a Windows 2000 or Windows 2003 production server it is good practice to perform a manual install (see the manual installation section in [[Windows_installation|Windows Installation]]).

*After installing the Windows package, you may wish to add additional contributed modules and plugins. Theset may involve more customization of configuration files.

*The latest complete install package version components, may not be backwardly compatible. Always check version compatibility of each component if you intend to develop materials on a later version of Moodle than the version installed on your "main" Moodle site. In short, complete install packages are designed for first time install on a "clean" machine.

== Security matters (A MUST READ!)==

As mentioned before, XAMPP is not meant for production use but only for developers
in a development environment. The way XAMPP is configured is to be open as possible
and allowing the developer anything he/she wants. For development environments this
is great but in a production environment it could be fatal. Here a list of missing security
in XAMPP:

The MySQL administrator (root) has no password.
The MySQL daemon is accessible via network.
phpMyAdmin is accessible via network.
Examples are accessible via network.

To fix most of the security weaknesses simply call the following URL:

<nowiki>http://localhost/security/</nowiki>

The root password for MySQL + phpMyAdmin and also a XAMPP directory protection can be established here.

Note that on the Windows installer package, some (all?) of these issues have been fixed already by default and the above link does not work.

If in doubt, more info is [http://www.apachefriends.org/en/faq-xampp-windows.html here]

== Apache and MySQL tweaks ==
Most of the time it is not necessary to tweak Apache or MySQL after completing the complete install package. Nor is it necessary to individually start and stop them because that is what the Xampp_start, Xampp_restart and Xammp_stop files are for.

=== Installing Apache and MySQL as services===
(This is only for NT4 | Windows 2000 | Windows XP operating systems)

\xampplite\apache\apache_installservice.bat =
==> Install Apache 2 as service

\xampplite\apache\apache_uninstallservice.bat =
==> Uninstall Apache 2 as service

\xampplite\mysql\mysql_installservice.bat =
==> Install MySQL as service

\xampplite\mysql\mysql_uninstallservice.bat =
==> Uninstall MySQL as service

==> After all Service (un)installations, please restart your system!

===Apache Notes===

You can use the apache_start and apache_stop bat files to start and stop apache from running. However the Xampp_start or Xampp_restart and Xampp_stop is recommended to turn on/off both Apache and MySQL.

====Troubleshooting====

If you find that Apache is very flaky, with the page often not loading properly or even at all (especially on localhost), try adding these lines to the end of C:\your_moodle_installer_directory\apache\conf\httpd.conf

EnableSendfile Off
EnableMMAP Off
Win32DisableAcceptEx

If You edit some .php files but browser still show old state of them, try to disable eAccelerator extension in \server\php\php.ini

[eAccelerator]
;extension=eaccelerator.dll

===MySQL notes===
Again, the recommendation to start and stop the entire webserver is to use the xampp_start or Xampp_restart and the Xampp_stop. The following maybe useful if you wish to tweak the system further. Please be careful.

(1) The MySQL server can be started by double-clicking (executing) mysql_start.bat. This file can be found in the same folder you installed xampp in, most likely this will be C:\xampplite\. The exact path to this file is X:\xampplite\mysql_start.bat, where "X" indicates the letter of the drive you unpacked xampp into.This batch file starts the MySQL server in console mode. The first intialization might take a few minutes.

Do not close the DOS window or you'll crash the server! To stop the server, please use mysql_shutdown.bat, which is located in the same directory.

(2) To use the MySQL Daemon with "innodb" for better performance,
please edit the "my" (or "my.cnf") file in the /xampplite/mysql/bin directory or for services the c:\my.cnf for windows NT/2000/XP. In that director, activate the
"innodb_data_file_path=ibdata1:30M"
statement. Attention, "innodb" is not recommended for 95/98/ME.

:To use MySQL as Service for NT/2000/XP, simply copy the "my" / "my.cnf" file to C:\my, or C:\my.cnf. Please note that this file has to be placed in C:\ (root), other locations are not permitted. Then execute the "mysql_installservice.bat" in the mysql folder.

(3) MySQL starts with standard values for the user id and the password. The preset user id is "root", the password is "" (= no password). To access MySQL via PHP with the preset values, you'll have to use the following syntax:
mysql_connect("localhost","root","");
If you want to set a password for MySQL access, please use of mysqladmin.
To set the password "secret" for the user "root", type the following:

\xampplite\mysql\bin\mysqladmin -u root password secret

After changing the password you'll have to reconfigure phpMyAdmin to use the new password, otherwise it won't be able to access the databases. To do that, open the file config.inc.php in \xampplite\phpmyadmin\ and edit the following lines:

$cfg['Servers'][$i]['user'] = 'root'; // MySQL user
$cfg['Servers'][$i]['auth_type'] = 'http'; // HTTP authentificate

So first the 'root' password is queried by the MySQL server, before phpMyAdmin may access.

Have a lot of fun! Viel Spaß! Bonne Chance!

==See also==

*[https://docs.moodle.org/19/en/Installation_guide_-_Moodle_for_Windows_on_a_USB_Memory_Stick Installation guide - Moodle 1.9 for Windows on a USB Memory Stick]
*Return to [[Windows installation]]
*[[Windows 1 computer many servers |Multiple web servers, on 1 computer]] similar to windows installation page, with some tips
*[https://docs.moodle.org/en/Windows_installation_using_XAMPP#Troubleshooting Troubleshooting]if you are running Skype.
*[[Installing_AMP]] lots of XAMPP stuff. XAMPP stands for X (cross platform), Apache, MySQL,PHP and Perl. XAMPP used in Moodle does not include Perl. MAMP stands for Mac, Apache, MySQL and PHP.
*[[Installation Package for OS X]]

[[es:Paquetes para Instalación Completa para Windows]]
[[pl:Kompletne pakiety instalacyjne]]
[[de:Vollständiges Installationspaket für Windows]]

[[Category:Installation]]
[[Category:Windows]]

Complete install packages for Windows

2016-09-27T09:27:29Z

Stronk7: Added MVC++ resdistributable requirement and links

{{Installing Moodle}}
Complete install packages are available from Moodle.org's [http://download.moodle.org/windows/ Windows download page] and from bitnami (for newer Windows versions). The packages are designed for new installations on a standalone computer. The complete install package can be used on a server, but '''it is not recommended that it be used as a production site'''. Please note Moodle.org's [http://download.moodle.org Standard install packages] only contain the Moodle code.

This document provides instructions for using the Windows packages. Separate instructions are available for [[Complete Install Packages for Mac OS X|Mac OS X packages]].

The complete install packages allow Moodle to be installed, along with the prerequisites that includes a web server, Apache, database, MySQL, scripting language, PHP, an administration tool, phpMyAdmin and Moodle all wrapped in the Xampp-lite shell. Several versions of the complete install package are available. The instructions on the download page provide guidance on which version is likely to be most suitable.

In short, complete install packages are designed to create a matched webserver and Moodle site on a standalone computer with minimal effort.

==System requirements==
:*256 MB RAM (minimum), 1GB RAM (recommended)
:*500 MB free Fixed Disk (more space will be needed depending on user uploads)
:* For old versions of Moodle:
:**Windows 98/ME (minimum)
:**Windows NT/2000/XP/2003 (recommended)
:* For Moodle 3.1 and later versions:
:**Windows Vista/7/8/10/2008/2012
:**Microsoft Visual C++ 2015 Redistributable package is required for PHP ([https://www.microsoft.com/en-us/download/details.aspx?id=48145 download link)].

===Port 80 Conflict if Skype is already installed===
As the Moodle Windows package uses the same port (80) as [http://www.skype.com/en/ Skype] does, it will not work if the computer has Skype already installed.

The fix is very simple: Exit Skype (don't just close the window), then start the Moodle Windows package. Once Moodle for Windows is running, it should be safe to start Skype again. If the local Moodle is using the port 80, Skype will automatically select a different port when it is run.

===Vista and Windows 7/8/10===

Packages generated for Moodle 3.1 and later versions should work with Vista/7/8/10 out of the box. They include PHP 7 and MariaDB instead of MySQL, resulting in a smoother experience than previous versions of the packages.

People facing problems with the new packages should:

:* Read the Requirements and Troubleshooting information, both here and in the package's README.txt file.
:* Report any consistent problem in the [https://tracker.moodle.org Moodle Tracker], so it can be investigated and, hopefully, fixed.
:* Consider installing a virtual machine (eg, [https://www.virtualbox.org/ VirtualBox]) with a windows or linux LAMP stack and then install Moodle there.
:* Use other Moodle packaged alternatives out there.

==Install complete package process==
The complete install package is a zip file that contains a webserver called [[Apache]], plus Moodle and Moodle's required [[MySQL]] database and [[PHP]] program.

There are three basic parts to the this install process.
#Download and unpack the complete install package.
#Start the webserver.
#Install Moodle using a web browser.

===First create file structure===
====Download the package====
[http://download.moodle.org/windows Download Windows] packed-zip file from Moodle.
[[Image:Moodle Setup zipfile.jpg|frame|center|A downloaded complete install package Windows 1.9 zip file in Windows Explorer]]

====Unpack the package====
Unpack (extract files by clicking on) the zip file you downloaded to a drive or partition of your choice. The extract process will create three files ("Start Moodle", "Stop Moodle", and "README") and a subfolder called "server".
*Do NOT rename the "server" subfolder
:''Note:'' There will also be a folder under this server subfolder, called \moodle that holds the Moodle program.

:''TIP:'' Create a folder and extract the files there. For example, you might have one folder called Moodle254 and another one called Moodle281 for different versions or purposes.

:''TIP:'' Make path to "server" subfolder simple. Best way if it will be in drive root. Like "D:\moodle281\server". A long path, especially with any strange symbols, can prevent XAMPP from working properly.

===Second - start the webserver===
Now you are ready to start the webserver. Use the "Start Moodle.exe" file which you should find in the top directory. Once the "Start Moodle.exe" program is open, don't close it; use "Stop Moodle.exe" for that purpose.

:''Note:'' These programs control both Apache and MySQL programs that operate the webserver. Some sites will individually start and stop Apache and MySQL with the Xampp bat files found in the "server" subfolder.

:''Tip:'' Alternatively, on a standalone computer with several potential webservers that might be running, you can use the "xampp_restart.exe" file in the "server" subfolder.

:''Tip:'' You can also add shortcuts to the commands that start and stop the site in your Windows "start" menu.

Now you are ready to start the Moodle installation.

:''Warning:'' Windows XP requires the msvcr71.dll library file in order to run Xampp. Installing the [http://www.microsoft.com/downloads/details.aspx?familyid=262D25E3-F589-4842-8157-034D1E7CF3A3&displaylang=en .Net 1.1 framework] (not .Net 2.0 and upper) could resolve it. You can also search for the file on Google, download it and copy it into the server/apache/bin folder.

===Third - start Moodle installation===
Start your web browser and type <nowiki> localhost, or http://127.0.0.1 or http://localhost </nowiki>in the address bar. You will either start your first time Moodle installation or if it is already installed you will enter the Moodle site's [[Front Page]] or Login screen.

[[Image:Moodle_Setup_localhost_browser.jpg|frame|center|A browser's addressbar showing "localhost". Click on the green Goto arrow will go to the installed Moodle site.]]

:''Tip:'' After Moodle installs, put the site in your "favorites" or as a "bookmark" in you browser.

====Set language====
The initial install page will be displayed after you type "localhost".

[[Image:C Install Windows 1.png|thumb|center|600px|Set initial language]]

*Choose your preferred language (English is used in this example) and click the “Next” button.

====Diagnostic results====
A diagnostic report is displayed – hopefully it will look like this, if not you may need to address some issues.
[[Image:Complete Windows Install 2.png|thumb|center|546px|Moodle liked and gave a Pass ]]

*Click the “Next” button to continue.

====Moodle paths====
The paths for your Moodle installation are shown – if you are only using this as a local testing server, accept the ones that are shown on your screen.

What you enter in the "Web Address" field depends on what you intend to use the new Moodle installation for.
If you are just going to use it for local testing, then use 'http://localhost'.
If you are going to test the new installation on a LAN, and will be accessing it from other machines on that LAN, then put the private IP address or network name of the serving machine, followed by a forward slash and moodle: Web Address - http://192.168.1.1/moodle
If you are going to test the installation on the internet, then you will need to put the public ip address followed by a forward slash and moodle: http://your_ip_address/moodle or you can put your domain name here instead.

[[image:Complete install Windows 3.png|thumb|center|600px|Installation paths]]

*Click the “Next” button to continue.

====Database configuration====
*In the next fields, we enter the database settings. The fields are populated with some suggested values.

*We strongly recommend you place a user name and password in this screen. (Don't forget them).

*DO NOT USE THE “ROOT” USER WITHOUT A PASSWORD FOR PRODUCTION INSTALLATIONS AS THIS CREATES A SECURITY VULNERABILITY
[[image:Complete install Windows 4.png|thumb|center|535px|Installation's database settings]]

*When the fields have been populated, click the “Next” button to continue.

====Check server====
The install process checks the server it installed.
[[image:Complete install Windows 5.png|thumb|center|535px|Check server environment screen]]
*Click the “Next” button to continue.

====Confirm initial language pack====
Moodle will now check to see if the language pack is available for the language you selected at the first step. If it is not, Moodle will continue with the install in English.
[[image:Complete install Windows 6.png|thumb|center|535px|Language pack check]]

====Confirm config.php====
Provided the Moodle folder is writable, a message confirming the configuration has been completed will be displayed.
[[image:Complete install Windows 7.png|thumb|center|549px|Confirmation that config.php has been created]]

*Click the “ Continue” button to proceed.

====Moodle copyright & agreement====
The Moodle copyright / license notices are displayed.

[[image:Complete install Windows 8.png|thumb|center|400px|Copyright notice and agreement]]

*Click the “Yes” button to continue.

====Current release and unattended option====
The current release information is shown.
'''Check off the unattended operations box'''. This will automatically advance through many screens. If you would like to watch the install screen by screen, do not check this box and be prepared to press the "continute button" many times.

*Click the "Continue" button and wait.
[[Image:Complete install Windows 9.png|thumb|center|600px|Current release and "unattended" check box]]

====Installation modules and blocks screens====
In most cases this will be followed by a series of screens that have a continue button on the bottom. This process stops with Admin user profile settings which needs to be filled out.

====Administrator user profile====
[[Image:Complete install Windows 10.png|thumb|center|The administrator's users profile screen]]

Fill out the required fields.
*Click on "Save" to continue

====Front page settings====
The next screen is the Front Page settings page. There are two parts to it.
The first part will ask for your Full site name and a short name for the navigation bar. There is also a place for a description. You can change these later.

[[Image:Complete install Windows 11a.png|thumb|center|The Moodle sites [[Front Page]] information]]

The second part on the bottom instructs Moodle if you will disable the new user self [[authentication]] through email process. The default is to disable. This can be changed later in the [[Site administration block|site administration block]].

[[Image:Complete install Windows 11ba.png|thumb|center|500px|Determine if users can create their own profiles when they log onto the side via email self authentication]]

*Click on "Save changes" button to go to Moodle sites home page.

====Moodle on====
'''Now you are ready to Moodle !'''

[[Image:Complete install Windows 12.png|thumb|center|Blank Front page of your new site]]

The Site Administration block is on the left, the "Turn edit on" button in the upper right corner, withe the site description block just below it.

===Congratulations - Moodle has been installed===
This finishes the installation of a complete package. Type <nowiki>http://localhost</nowiki> (or what ever you set for web address earlier in the setup!) in your browser and Moodle will open.

Your next task will be to configure Moodle to meet your needs. Don't worry, it is easy to change any of the settings now that Moodle is up and running.
*Check ''Settings > Site administration'' for further links.

==More tips and cautions==
*For installation on a Windows 2000 or Windows 2003 production server it is good practice to perform a manual install (see the manual installation section in [[Windows_installation|Windows Installation]]).

*After installing the Windows package, you may wish to add additional contributed modules and plugins. Theset may involve more customization of configuration files.

*The latest complete install package version components, may not be backwardly compatible. Always check version compatibility of each component if you intend to develop materials on a later version of Moodle than the version installed on your "main" Moodle site. In short, complete install packages are designed for first time install on a "clean" machine.

== Security matters (A MUST READ!)==

As mentioned before, XAMPP is not meant for production use but only for developers
in a development environment. The way XAMPP is configured is to be open as possible
and allowing the developer anything he/she wants. For development environments this
is great but in a production environment it could be fatal. Here a list of missing security
in XAMPP:

The MySQL administrator (root) has no password.
The MySQL daemon is accessible via network.
phpMyAdmin is accessible via network.
Examples are accessible via network.

To fix most of the security weaknesses simply call the following URL:

<nowiki>http://localhost/security/</nowiki>

The root password for MySQL + phpMyAdmin and also a XAMPP directory protection can be established here.

Note that on the Windows installer package, some (all?) of these issues have been fixed already by default and the above link does not work.

If in doubt, more info is [http://www.apachefriends.org/en/faq-xampp-windows.html here]

== Apache and MySQL tweaks ==
Most of the time it is not necessary to tweak Apache or MySQL after completing the complete install package. Nor is it necessary to individually start and stop them because that is what the Xampp_start, Xampp_restart and Xammp_stop files are for.

=== Installing Apache and MySQL as services===
(This is only for NT4 | Windows 2000 | Windows XP operating systems)

\xampplite\apache\apache_installservice.bat =
==> Install Apache 2 as service

\xampplite\apache\apache_uninstallservice.bat =
==> Uninstall Apache 2 as service

\xampplite\mysql\mysql_installservice.bat =
==> Install MySQL as service

\xampplite\mysql\mysql_uninstallservice.bat =
==> Uninstall MySQL as service

==> After all Service (un)installations, please restart your system!

===Apache Notes===

You can use the apache_start and apache_stop bat files to start and stop apache from running. However the Xampp_start or Xampp_restart and Xampp_stop is recommended to turn on/off both Apache and MySQL.

====Troubleshooting====

If you find that Apache is very flaky, with the page often not loading properly or even at all (especially on localhost), try adding these lines to the end of C:\your_moodle_installer_directory\apache\conf\httpd.conf

EnableSendfile Off
EnableMMAP Off
Win32DisableAcceptEx

If You edit some .php files but browser still show old state of them, try to disable eAccelerator extension in \server\php\php.ini

[eAccelerator]
;extension=eaccelerator.dll

===MySQL notes===
Again, the recommendation to start and stop the entire webserver is to use the xampp_start or Xampp_restart and the Xampp_stop. The following maybe useful if you wish to tweak the system further. Please be careful.

(1) The MySQL server can be started by double-clicking (executing) mysql_start.bat. This file can be found in the same folder you installed xampp in, most likely this will be C:\xampplite\. The exact path to this file is X:\xampplite\mysql_start.bat, where "X" indicates the letter of the drive you unpacked xampp into.This batch file starts the MySQL server in console mode. The first intialization might take a few minutes.

Do not close the DOS window or you'll crash the server! To stop the server, please use mysql_shutdown.bat, which is located in the same directory.

(2) To use the MySQL Daemon with "innodb" for better performance,
please edit the "my" (or "my.cnf") file in the /xampplite/mysql/bin directory or for services the c:\my.cnf for windows NT/2000/XP. In that director, activate the
"innodb_data_file_path=ibdata1:30M"
statement. Attention, "innodb" is not recommended for 95/98/ME.

:To use MySQL as Service for NT/2000/XP, simply copy the "my" / "my.cnf" file to C:\my, or C:\my.cnf. Please note that this file has to be placed in C:\ (root), other locations are not permitted. Then execute the "mysql_installservice.bat" in the mysql folder.

(3) MySQL starts with standard values for the user id and the password. The preset user id is "root", the password is "" (= no password). To access MySQL via PHP with the preset values, you'll have to use the following syntax:
mysql_connect("localhost","root","");
If you want to set a password for MySQL access, please use of mysqladmin.
To set the password "secret" for the user "root", type the following:

\xampplite\mysql\bin\mysqladmin -u root password secret

After changing the password you'll have to reconfigure phpMyAdmin to use the new password, otherwise it won't be able to access the databases. To do that, open the file config.inc.php in \xampplite\phpmyadmin\ and edit the following lines:

$cfg['Servers'][$i]['user'] = 'root'; // MySQL user
$cfg['Servers'][$i]['auth_type'] = 'http'; // HTTP authentificate

So first the 'root' password is queried by the MySQL server, before phpMyAdmin may access.

Have a lot of fun! Viel Spaß! Bonne Chance!

==See also==

*[https://docs.moodle.org/19/en/Installation_guide_-_Moodle_for_Windows_on_a_USB_Memory_Stick Installation guide - Moodle 1.9 for Windows on a USB Memory Stick]
*Return to [[Windows installation]]
*[[Windows 1 computer many servers |Multiple web servers, on 1 computer]] similar to windows installation page, with some tips
*[https://docs.moodle.org/en/Windows_installation_using_XAMPP#Troubleshooting Troubleshooting]if you are running Skype.
*[[Installing_AMP]] lots of XAMPP stuff. XAMPP stands for X (cross platform), Apache, MySQL,PHP and Perl. XAMPP used in Moodle does not include Perl. MAMP stands for Mac, Apache, MySQL and PHP.
*[[Installation Package for OS X]]

[[es:Paquetes para Instalación Completa para Windows]]
[[pl:Kompletne pakiety instalacyjne]]
[[de:Vollständiges Installationspaket für Windows]]

[[Category:Installation]]
[[Category:Windows]]

Complete install packages for Windows

2016-09-27T09:22:50Z

Stronk7: new packages supporting vista and later available

{{Installing Moodle}}
Complete install packages are available from Moodle.org's [http://download.moodle.org/windows/ Windows download page] and from bitnami (for newer Windows versions). The packages are designed for new installations on a standalone computer. The complete install package can be used on a server, but '''it is not recommended that it be used as a production site'''. Please note Moodle.org's [http://download.moodle.org Standard install packages] only contain the Moodle code.

This document provides instructions for using the Windows packages. Separate instructions are available for [[Complete Install Packages for Mac OS X|Mac OS X packages]].

The complete install packages allow Moodle to be installed, along with the prerequisites that includes a web server, Apache, database, MySQL, scripting language, PHP, an administration tool, phpMyAdmin and Moodle all wrapped in the Xampp-lite shell. Several versions of the complete install package are available. The instructions on the download page provide guidance on which version is likely to be most suitable.

In short, complete install packages are designed to create a matched webserver and Moodle site on a standalone computer with minimal effort.

==System requirements==
:*256 MB RAM (minimum), 1GB RAM (recommended)
:*500 MB free Fixed Disk (more space will be needed depending on user uploads)
:* For old versions of Moodle:
:**Windows 98/ME (minimum)
:**Windows NT/2000/XP/2003 (recommended)
:* For Moodle 3.1 and later versions:
:**Windows Vista/7/8/10/2008/2012

===Port 80 Conflict if Skype is already installed===
As the Moodle Windows package uses the same port (80) as [http://www.skype.com/en/ Skype] does, it will not work if the computer has Skype already installed.

The fix is very simple: Exit Skype (don't just close the window), then start the Moodle Windows package. Once Moodle for Windows is running, it should be safe to start Skype again. If the local Moodle is using the port 80, Skype will automatically select a different port when it is run.

===Vista and Windows 7/8/10===

Packages generated for Moodle 3.1 and later versions should work with Vista/7/8/10 out of the box. They include PHP 7 and MariaDB instead of MySQL, resulting in a smoother experience than previous versions of the packages.

People facing problems with the new packages should:

:* Read the Troubleshooting information, both here and in the package's README.txt file.
:* Report any consistent problem in the Moodle Tracker, so it can be investigated and, hopefully, fixed.
:* Consider installing a virtual machine (eg, [https://www.virtualbox.org/ VirtualBox]) with a windows or linux LAMP stack and then install Moodle there.
:* Use other Moodle packaged alternatives out there.

==Install complete package process==
The complete install package is a zip file that contains a webserver called [[Apache]], plus Moodle and Moodle's required [[MySQL]] database and [[PHP]] program.

There are three basic parts to the this install process.
#Download and unpack the complete install package.
#Start the webserver.
#Install Moodle using a web browser.

===First create file structure===
====Download the package====
[http://download.moodle.org/windows Download Windows] packed-zip file from Moodle.
[[Image:Moodle Setup zipfile.jpg|frame|center|A downloaded complete install package Windows 1.9 zip file in Windows Explorer]]

====Unpack the package====
Unpack (extract files by clicking on) the zip file you downloaded to a drive or partition of your choice. The extract process will create three files ("Start Moodle", "Stop Moodle", and "README") and a subfolder called "server".
*Do NOT rename the "server" subfolder
:''Note:'' There will also be a folder under this server subfolder, called \moodle that holds the Moodle program.

:''TIP:'' Create a folder and extract the files there. For example, you might have one folder called Moodle254 and another one called Moodle281 for different versions or purposes.

:''TIP:'' Make path to "server" subfolder simple. Best way if it will be in drive root. Like "D:\moodle281\server". A long path, especially with any strange symbols, can prevent XAMPP from working properly.

===Second - start the webserver===
Now you are ready to start the webserver. Use the "Start Moodle.exe" file which you should find in the top directory. Once the "Start Moodle.exe" program is open, don't close it; use "Stop Moodle.exe" for that purpose.

:''Note:'' These programs control both Apache and MySQL programs that operate the webserver. Some sites will individually start and stop Apache and MySQL with the Xampp bat files found in the "server" subfolder.

:''Tip:'' Alternatively, on a standalone computer with several potential webservers that might be running, you can use the "xampp_restart.exe" file in the "server" subfolder.

:''Tip:'' You can also add shortcuts to the commands that start and stop the site in your Windows "start" menu.

Now you are ready to start the Moodle installation.

:''Warning:'' Windows XP requires the msvcr71.dll library file in order to run Xampp. Installing the [http://www.microsoft.com/downloads/details.aspx?familyid=262D25E3-F589-4842-8157-034D1E7CF3A3&displaylang=en .Net 1.1 framework] (not .Net 2.0 and upper) could resolve it. You can also search for the file on Google, download it and copy it into the server/apache/bin folder.

===Third - start Moodle installation===
Start your web browser and type <nowiki> localhost, or http://127.0.0.1 or http://localhost </nowiki>in the address bar. You will either start your first time Moodle installation or if it is already installed you will enter the Moodle site's [[Front Page]] or Login screen.

[[Image:Moodle_Setup_localhost_browser.jpg|frame|center|A browser's addressbar showing "localhost". Click on the green Goto arrow will go to the installed Moodle site.]]

:''Tip:'' After Moodle installs, put the site in your "favorites" or as a "bookmark" in you browser.

====Set language====
The initial install page will be displayed after you type "localhost".

[[Image:C Install Windows 1.png|thumb|center|600px|Set initial language]]

*Choose your preferred language (English is used in this example) and click the “Next” button.

====Diagnostic results====
A diagnostic report is displayed – hopefully it will look like this, if not you may need to address some issues.
[[Image:Complete Windows Install 2.png|thumb|center|546px|Moodle liked and gave a Pass ]]

*Click the “Next” button to continue.

====Moodle paths====
The paths for your Moodle installation are shown – if you are only using this as a local testing server, accept the ones that are shown on your screen.

What you enter in the "Web Address" field depends on what you intend to use the new Moodle installation for.
If you are just going to use it for local testing, then use 'http://localhost'.
If you are going to test the new installation on a LAN, and will be accessing it from other machines on that LAN, then put the private IP address or network name of the serving machine, followed by a forward slash and moodle: Web Address - http://192.168.1.1/moodle
If you are going to test the installation on the internet, then you will need to put the public ip address followed by a forward slash and moodle: http://your_ip_address/moodle or you can put your domain name here instead.

[[image:Complete install Windows 3.png|thumb|center|600px|Installation paths]]

*Click the “Next” button to continue.

====Database configuration====
*In the next fields, we enter the database settings. The fields are populated with some suggested values.

*We strongly recommend you place a user name and password in this screen. (Don't forget them).

*DO NOT USE THE “ROOT” USER WITHOUT A PASSWORD FOR PRODUCTION INSTALLATIONS AS THIS CREATES A SECURITY VULNERABILITY
[[image:Complete install Windows 4.png|thumb|center|535px|Installation's database settings]]

*When the fields have been populated, click the “Next” button to continue.

====Check server====
The install process checks the server it installed.
[[image:Complete install Windows 5.png|thumb|center|535px|Check server environment screen]]
*Click the “Next” button to continue.

====Confirm initial language pack====
Moodle will now check to see if the language pack is available for the language you selected at the first step. If it is not, Moodle will continue with the install in English.
[[image:Complete install Windows 6.png|thumb|center|535px|Language pack check]]

====Confirm config.php====
Provided the Moodle folder is writable, a message confirming the configuration has been completed will be displayed.
[[image:Complete install Windows 7.png|thumb|center|549px|Confirmation that config.php has been created]]

*Click the “ Continue” button to proceed.

====Moodle copyright & agreement====
The Moodle copyright / license notices are displayed.

[[image:Complete install Windows 8.png|thumb|center|400px|Copyright notice and agreement]]

*Click the “Yes” button to continue.

====Current release and unattended option====
The current release information is shown.
'''Check off the unattended operations box'''. This will automatically advance through many screens. If you would like to watch the install screen by screen, do not check this box and be prepared to press the "continute button" many times.

*Click the "Continue" button and wait.
[[Image:Complete install Windows 9.png|thumb|center|600px|Current release and "unattended" check box]]

====Installation modules and blocks screens====
In most cases this will be followed by a series of screens that have a continue button on the bottom. This process stops with Admin user profile settings which needs to be filled out.

====Administrator user profile====
[[Image:Complete install Windows 10.png|thumb|center|The administrator's users profile screen]]

Fill out the required fields.
*Click on "Save" to continue

====Front page settings====
The next screen is the Front Page settings page. There are two parts to it.
The first part will ask for your Full site name and a short name for the navigation bar. There is also a place for a description. You can change these later.

[[Image:Complete install Windows 11a.png|thumb|center|The Moodle sites [[Front Page]] information]]

The second part on the bottom instructs Moodle if you will disable the new user self [[authentication]] through email process. The default is to disable. This can be changed later in the [[Site administration block|site administration block]].

[[Image:Complete install Windows 11ba.png|thumb|center|500px|Determine if users can create their own profiles when they log onto the side via email self authentication]]

*Click on "Save changes" button to go to Moodle sites home page.

====Moodle on====
'''Now you are ready to Moodle !'''

[[Image:Complete install Windows 12.png|thumb|center|Blank Front page of your new site]]

The Site Administration block is on the left, the "Turn edit on" button in the upper right corner, withe the site description block just below it.

===Congratulations - Moodle has been installed===
This finishes the installation of a complete package. Type <nowiki>http://localhost</nowiki> (or what ever you set for web address earlier in the setup!) in your browser and Moodle will open.

Your next task will be to configure Moodle to meet your needs. Don't worry, it is easy to change any of the settings now that Moodle is up and running.
*Check ''Settings > Site administration'' for further links.

==More tips and cautions==
*For installation on a Windows 2000 or Windows 2003 production server it is good practice to perform a manual install (see the manual installation section in [[Windows_installation|Windows Installation]]).

*After installing the Windows package, you may wish to add additional contributed modules and plugins. Theset may involve more customization of configuration files.

*The latest complete install package version components, may not be backwardly compatible. Always check version compatibility of each component if you intend to develop materials on a later version of Moodle than the version installed on your "main" Moodle site. In short, complete install packages are designed for first time install on a "clean" machine.

== Security matters (A MUST READ!)==

As mentioned before, XAMPP is not meant for production use but only for developers
in a development environment. The way XAMPP is configured is to be open as possible
and allowing the developer anything he/she wants. For development environments this
is great but in a production environment it could be fatal. Here a list of missing security
in XAMPP:

The MySQL administrator (root) has no password.
The MySQL daemon is accessible via network.
phpMyAdmin is accessible via network.
Examples are accessible via network.

To fix most of the security weaknesses simply call the following URL:

<nowiki>http://localhost/security/</nowiki>

The root password for MySQL + phpMyAdmin and also a XAMPP directory protection can be established here.

Note that on the Windows installer package, some (all?) of these issues have been fixed already by default and the above link does not work.

If in doubt, more info is [http://www.apachefriends.org/en/faq-xampp-windows.html here]

== Apache and MySQL tweaks ==
Most of the time it is not necessary to tweak Apache or MySQL after completing the complete install package. Nor is it necessary to individually start and stop them because that is what the Xampp_start, Xampp_restart and Xammp_stop files are for.

=== Installing Apache and MySQL as services===
(This is only for NT4 | Windows 2000 | Windows XP operating systems)

\xampplite\apache\apache_installservice.bat =
==> Install Apache 2 as service

\xampplite\apache\apache_uninstallservice.bat =
==> Uninstall Apache 2 as service

\xampplite\mysql\mysql_installservice.bat =
==> Install MySQL as service

\xampplite\mysql\mysql_uninstallservice.bat =
==> Uninstall MySQL as service

==> After all Service (un)installations, please restart your system!

===Apache Notes===

You can use the apache_start and apache_stop bat files to start and stop apache from running. However the Xampp_start or Xampp_restart and Xampp_stop is recommended to turn on/off both Apache and MySQL.

====Troubleshooting====

If you find that Apache is very flaky, with the page often not loading properly or even at all (especially on localhost), try adding these lines to the end of C:\your_moodle_installer_directory\apache\conf\httpd.conf

EnableSendfile Off
EnableMMAP Off
Win32DisableAcceptEx

If You edit some .php files but browser still show old state of them, try to disable eAccelerator extension in \server\php\php.ini

[eAccelerator]
;extension=eaccelerator.dll

===MySQL notes===
Again, the recommendation to start and stop the entire webserver is to use the xampp_start or Xampp_restart and the Xampp_stop. The following maybe useful if you wish to tweak the system further. Please be careful.

(1) The MySQL server can be started by double-clicking (executing) mysql_start.bat. This file can be found in the same folder you installed xampp in, most likely this will be C:\xampplite\. The exact path to this file is X:\xampplite\mysql_start.bat, where "X" indicates the letter of the drive you unpacked xampp into.This batch file starts the MySQL server in console mode. The first intialization might take a few minutes.

Do not close the DOS window or you'll crash the server! To stop the server, please use mysql_shutdown.bat, which is located in the same directory.

(2) To use the MySQL Daemon with "innodb" for better performance,
please edit the "my" (or "my.cnf") file in the /xampplite/mysql/bin directory or for services the c:\my.cnf for windows NT/2000/XP. In that director, activate the
"innodb_data_file_path=ibdata1:30M"
statement. Attention, "innodb" is not recommended for 95/98/ME.

:To use MySQL as Service for NT/2000/XP, simply copy the "my" / "my.cnf" file to C:\my, or C:\my.cnf. Please note that this file has to be placed in C:\ (root), other locations are not permitted. Then execute the "mysql_installservice.bat" in the mysql folder.

(3) MySQL starts with standard values for the user id and the password. The preset user id is "root", the password is "" (= no password). To access MySQL via PHP with the preset values, you'll have to use the following syntax:
mysql_connect("localhost","root","");
If you want to set a password for MySQL access, please use of mysqladmin.
To set the password "secret" for the user "root", type the following:

\xampplite\mysql\bin\mysqladmin -u root password secret

After changing the password you'll have to reconfigure phpMyAdmin to use the new password, otherwise it won't be able to access the databases. To do that, open the file config.inc.php in \xampplite\phpmyadmin\ and edit the following lines:

$cfg['Servers'][$i]['user'] = 'root'; // MySQL user
$cfg['Servers'][$i]['auth_type'] = 'http'; // HTTP authentificate

So first the 'root' password is queried by the MySQL server, before phpMyAdmin may access.

Have a lot of fun! Viel Spaß! Bonne Chance!

==See also==

*[https://docs.moodle.org/19/en/Installation_guide_-_Moodle_for_Windows_on_a_USB_Memory_Stick Installation guide - Moodle 1.9 for Windows on a USB Memory Stick]
*Return to [[Windows installation]]
*[[Windows 1 computer many servers |Multiple web servers, on 1 computer]] similar to windows installation page, with some tips
*[https://docs.moodle.org/en/Windows_installation_using_XAMPP#Troubleshooting Troubleshooting]if you are running Skype.
*[[Installing_AMP]] lots of XAMPP stuff. XAMPP stands for X (cross platform), Apache, MySQL,PHP and Perl. XAMPP used in Moodle does not include Perl. MAMP stands for Mac, Apache, MySQL and PHP.
*[[Installation Package for OS X]]

[[es:Paquetes para Instalación Completa para Windows]]
[[pl:Kompletne pakiety instalacyjne]]
[[de:Vollständiges Installationspaket für Windows]]

[[Category:Installation]]
[[Category:Windows]]

Complete install packages for Windows

2016-09-27T09:11:59Z

Stronk7: updating requirements for 3.1 and up

{{Installing Moodle}}
Complete install packages are available from Moodle.org's [http://download.moodle.org/windows/ Windows download page] and from bitnami (for newer Windows versions). The packages are designed for new installations on a standalone computer. The complete install package can be used on a server, but '''it is not recommended that it be used as a production site'''. Please note Moodle.org's [http://download.moodle.org Standard install packages] only contain the Moodle code.

This document provides instructions for using the Windows packages. Separate instructions are available for [[Complete Install Packages for Mac OS X|Mac OS X packages]].

The complete install packages allow Moodle to be installed, along with the prerequisites that includes a web server, Apache, database, MySQL, scripting language, PHP, an administration tool, phpMyAdmin and Moodle all wrapped in the Xampp-lite shell. Several versions of the complete install package are available. The instructions on the download page provide guidance on which version is likely to be most suitable.

In short, complete install packages are designed to create a matched webserver and Moodle site on a standalone computer with minimal effort.

==System requirements==
:*256 MB RAM (minimum), 1GB RAM (recommended)
:*500 MB free Fixed Disk (more space will be needed depending on user uploads)
:* For old versions of Moodle:
:**Windows 98/ME (minimum)
:**Windows NT/2000/XP/2003 (recommended)
:* For Moodle 3.1 and later versions:
:**Windows Vista/7/8/10/2008/2012

===Port 80 Conflict if Skype is already installed===
As the Moodle Windows package uses the same port (80) as [http://www.skype.com/en/ Skype] does, it will not work if the computer has Skype already installed.

The fix is very simple: Exit Skype (don't just close the window), then start the Moodle Windows package. Once Moodle for Windows is running, it should be safe to start Skype again. If the local Moodle is using the port 80, Skype will automatically select a different port when it is run.

===Vista and Windows 7/8/10===

* Many people have trouble installing the packages for Windows on Vista and Windows 7, 8 and 10.
* Some people had previously used the packages in Windows 7 and reported that they no longer work under Windows 10. You only have one month to uninstall the Windows 10 upgrade!
* There seems to be a problem with the enclosed XAMPP package and the Windows OSes, and trying to use the compatibilty settings of Windows does not work.
* You can install a virtual machine (eg, [https://www.virtualbox.org/ VirtualBox]) with a Windows 7 guest, or a more solid Linux guest !

One simple solution is to use http://bitnami.org/stack/moodle (from amazon.com).

==Install complete package process==
The complete install package is a zip file that contains a webserver called [[Apache]], plus Moodle and Moodle's required [[MySQL]] database and [[PHP]] program.

There are three basic parts to the this install process.
#Download and unpack the complete install package.
#Start the webserver.
#Install Moodle using a web browser.

===First create file structure===
====Download the package====
[http://download.moodle.org/windows Download Windows] packed-zip file from Moodle.
[[Image:Moodle Setup zipfile.jpg|frame|center|A downloaded complete install package Windows 1.9 zip file in Windows Explorer]]

====Unpack the package====
Unpack (extract files by clicking on) the zip file you downloaded to a drive or partition of your choice. The extract process will create three files ("Start Moodle", "Stop Moodle", and "README") and a subfolder called "server".
*Do NOT rename the "server" subfolder
:''Note:'' There will also be a folder under this server subfolder, called \moodle that holds the Moodle program.

:''TIP:'' Create a folder and extract the files there. For example, you might have one folder called Moodle254 and another one called Moodle281 for different versions or purposes.

:''TIP:'' Make path to "server" subfolder simple. Best way if it will be in drive root. Like "D:\moodle281\server". A long path, especially with any strange symbols, can prevent XAMPP from working properly.

===Second - start the webserver===
Now you are ready to start the webserver. Use the "Start Moodle.exe" file which you should find in the top directory. Once the "Start Moodle.exe" program is open, don't close it; use "Stop Moodle.exe" for that purpose.

:''Note:'' These programs control both Apache and MySQL programs that operate the webserver. Some sites will individually start and stop Apache and MySQL with the Xampp bat files found in the "server" subfolder.

:''Tip:'' Alternatively, on a standalone computer with several potential webservers that might be running, you can use the "xampp_restart.exe" file in the "server" subfolder.

:''Tip:'' You can also add shortcuts to the commands that start and stop the site in your Windows "start" menu.

Now you are ready to start the Moodle installation.

:''Warning:'' Windows XP requires the msvcr71.dll library file in order to run Xampp. Installing the [http://www.microsoft.com/downloads/details.aspx?familyid=262D25E3-F589-4842-8157-034D1E7CF3A3&displaylang=en .Net 1.1 framework] (not .Net 2.0 and upper) could resolve it. You can also search for the file on Google, download it and copy it into the server/apache/bin folder.

===Third - start Moodle installation===
Start your web browser and type <nowiki> localhost, or http://127.0.0.1 or http://localhost </nowiki>in the address bar. You will either start your first time Moodle installation or if it is already installed you will enter the Moodle site's [[Front Page]] or Login screen.

[[Image:Moodle_Setup_localhost_browser.jpg|frame|center|A browser's addressbar showing "localhost". Click on the green Goto arrow will go to the installed Moodle site.]]

:''Tip:'' After Moodle installs, put the site in your "favorites" or as a "bookmark" in you browser.

====Set language====
The initial install page will be displayed after you type "localhost".

[[Image:C Install Windows 1.png|thumb|center|600px|Set initial language]]

*Choose your preferred language (English is used in this example) and click the “Next” button.

====Diagnostic results====
A diagnostic report is displayed – hopefully it will look like this, if not you may need to address some issues.
[[Image:Complete Windows Install 2.png|thumb|center|546px|Moodle liked and gave a Pass ]]

*Click the “Next” button to continue.

====Moodle paths====
The paths for your Moodle installation are shown – if you are only using this as a local testing server, accept the ones that are shown on your screen.

What you enter in the "Web Address" field depends on what you intend to use the new Moodle installation for.
If you are just going to use it for local testing, then use 'http://localhost'.
If you are going to test the new installation on a LAN, and will be accessing it from other machines on that LAN, then put the private IP address or network name of the serving machine, followed by a forward slash and moodle: Web Address - http://192.168.1.1/moodle
If you are going to test the installation on the internet, then you will need to put the public ip address followed by a forward slash and moodle: http://your_ip_address/moodle or you can put your domain name here instead.

[[image:Complete install Windows 3.png|thumb|center|600px|Installation paths]]

*Click the “Next” button to continue.

====Database configuration====
*In the next fields, we enter the database settings. The fields are populated with some suggested values.

*We strongly recommend you place a user name and password in this screen. (Don't forget them).

*DO NOT USE THE “ROOT” USER WITHOUT A PASSWORD FOR PRODUCTION INSTALLATIONS AS THIS CREATES A SECURITY VULNERABILITY
[[image:Complete install Windows 4.png|thumb|center|535px|Installation's database settings]]

*When the fields have been populated, click the “Next” button to continue.

====Check server====
The install process checks the server it installed.
[[image:Complete install Windows 5.png|thumb|center|535px|Check server environment screen]]
*Click the “Next” button to continue.

====Confirm initial language pack====
Moodle will now check to see if the language pack is available for the language you selected at the first step. If it is not, Moodle will continue with the install in English.
[[image:Complete install Windows 6.png|thumb|center|535px|Language pack check]]

====Confirm config.php====
Provided the Moodle folder is writable, a message confirming the configuration has been completed will be displayed.
[[image:Complete install Windows 7.png|thumb|center|549px|Confirmation that config.php has been created]]

*Click the “ Continue” button to proceed.

====Moodle copyright & agreement====
The Moodle copyright / license notices are displayed.

[[image:Complete install Windows 8.png|thumb|center|400px|Copyright notice and agreement]]

*Click the “Yes” button to continue.

====Current release and unattended option====
The current release information is shown.
'''Check off the unattended operations box'''. This will automatically advance through many screens. If you would like to watch the install screen by screen, do not check this box and be prepared to press the "continute button" many times.

*Click the "Continue" button and wait.
[[Image:Complete install Windows 9.png|thumb|center|600px|Current release and "unattended" check box]]

====Installation modules and blocks screens====
In most cases this will be followed by a series of screens that have a continue button on the bottom. This process stops with Admin user profile settings which needs to be filled out.

====Administrator user profile====
[[Image:Complete install Windows 10.png|thumb|center|The administrator's users profile screen]]

Fill out the required fields.
*Click on "Save" to continue

====Front page settings====
The next screen is the Front Page settings page. There are two parts to it.
The first part will ask for your Full site name and a short name for the navigation bar. There is also a place for a description. You can change these later.

[[Image:Complete install Windows 11a.png|thumb|center|The Moodle sites [[Front Page]] information]]

The second part on the bottom instructs Moodle if you will disable the new user self [[authentication]] through email process. The default is to disable. This can be changed later in the [[Site administration block|site administration block]].

[[Image:Complete install Windows 11ba.png|thumb|center|500px|Determine if users can create their own profiles when they log onto the side via email self authentication]]

*Click on "Save changes" button to go to Moodle sites home page.

====Moodle on====
'''Now you are ready to Moodle !'''

[[Image:Complete install Windows 12.png|thumb|center|Blank Front page of your new site]]

The Site Administration block is on the left, the "Turn edit on" button in the upper right corner, withe the site description block just below it.

===Congratulations - Moodle has been installed===
This finishes the installation of a complete package. Type <nowiki>http://localhost</nowiki> (or what ever you set for web address earlier in the setup!) in your browser and Moodle will open.

Your next task will be to configure Moodle to meet your needs. Don't worry, it is easy to change any of the settings now that Moodle is up and running.
*Check ''Settings > Site administration'' for further links.

==More tips and cautions==
*For installation on a Windows 2000 or Windows 2003 production server it is good practice to perform a manual install (see the manual installation section in [[Windows_installation|Windows Installation]]).

*After installing the Windows package, you may wish to add additional contributed modules and plugins. Theset may involve more customization of configuration files.

*The latest complete install package version components, may not be backwardly compatible. Always check version compatibility of each component if you intend to develop materials on a later version of Moodle than the version installed on your "main" Moodle site. In short, complete install packages are designed for first time install on a "clean" machine.

== Security matters (A MUST READ!)==

As mentioned before, XAMPP is not meant for production use but only for developers
in a development environment. The way XAMPP is configured is to be open as possible
and allowing the developer anything he/she wants. For development environments this
is great but in a production environment it could be fatal. Here a list of missing security
in XAMPP:

The MySQL administrator (root) has no password.
The MySQL daemon is accessible via network.
phpMyAdmin is accessible via network.
Examples are accessible via network.

To fix most of the security weaknesses simply call the following URL:

<nowiki>http://localhost/security/</nowiki>

The root password for MySQL + phpMyAdmin and also a XAMPP directory protection can be established here.

Note that on the Windows installer package, some (all?) of these issues have been fixed already by default and the above link does not work.

If in doubt, more info is [http://www.apachefriends.org/en/faq-xampp-windows.html here]

== Apache and MySQL tweaks ==
Most of the time it is not necessary to tweak Apache or MySQL after completing the complete install package. Nor is it necessary to individually start and stop them because that is what the Xampp_start, Xampp_restart and Xammp_stop files are for.

=== Installing Apache and MySQL as services===
(This is only for NT4 | Windows 2000 | Windows XP operating systems)

\xampplite\apache\apache_installservice.bat =
==> Install Apache 2 as service

\xampplite\apache\apache_uninstallservice.bat =
==> Uninstall Apache 2 as service

\xampplite\mysql\mysql_installservice.bat =
==> Install MySQL as service

\xampplite\mysql\mysql_uninstallservice.bat =
==> Uninstall MySQL as service

==> After all Service (un)installations, please restart your system!

===Apache Notes===

You can use the apache_start and apache_stop bat files to start and stop apache from running. However the Xampp_start or Xampp_restart and Xampp_stop is recommended to turn on/off both Apache and MySQL.

====Troubleshooting====

If you find that Apache is very flaky, with the page often not loading properly or even at all (especially on localhost), try adding these lines to the end of C:\your_moodle_installer_directory\apache\conf\httpd.conf

EnableSendfile Off
EnableMMAP Off
Win32DisableAcceptEx

If You edit some .php files but browser still show old state of them, try to disable eAccelerator extension in \server\php\php.ini

[eAccelerator]
;extension=eaccelerator.dll

===MySQL notes===
Again, the recommendation to start and stop the entire webserver is to use the xampp_start or Xampp_restart and the Xampp_stop. The following maybe useful if you wish to tweak the system further. Please be careful.

(1) The MySQL server can be started by double-clicking (executing) mysql_start.bat. This file can be found in the same folder you installed xampp in, most likely this will be C:\xampplite\. The exact path to this file is X:\xampplite\mysql_start.bat, where "X" indicates the letter of the drive you unpacked xampp into.This batch file starts the MySQL server in console mode. The first intialization might take a few minutes.

Do not close the DOS window or you'll crash the server! To stop the server, please use mysql_shutdown.bat, which is located in the same directory.

(2) To use the MySQL Daemon with "innodb" for better performance,
please edit the "my" (or "my.cnf") file in the /xampplite/mysql/bin directory or for services the c:\my.cnf for windows NT/2000/XP. In that director, activate the
"innodb_data_file_path=ibdata1:30M"
statement. Attention, "innodb" is not recommended for 95/98/ME.

:To use MySQL as Service for NT/2000/XP, simply copy the "my" / "my.cnf" file to C:\my, or C:\my.cnf. Please note that this file has to be placed in C:\ (root), other locations are not permitted. Then execute the "mysql_installservice.bat" in the mysql folder.

(3) MySQL starts with standard values for the user id and the password. The preset user id is "root", the password is "" (= no password). To access MySQL via PHP with the preset values, you'll have to use the following syntax:
mysql_connect("localhost","root","");
If you want to set a password for MySQL access, please use of mysqladmin.
To set the password "secret" for the user "root", type the following:

\xampplite\mysql\bin\mysqladmin -u root password secret

After changing the password you'll have to reconfigure phpMyAdmin to use the new password, otherwise it won't be able to access the databases. To do that, open the file config.inc.php in \xampplite\phpmyadmin\ and edit the following lines:

$cfg['Servers'][$i]['user'] = 'root'; // MySQL user
$cfg['Servers'][$i]['auth_type'] = 'http'; // HTTP authentificate

So first the 'root' password is queried by the MySQL server, before phpMyAdmin may access.

Have a lot of fun! Viel Spaß! Bonne Chance!

==See also==

*[https://docs.moodle.org/19/en/Installation_guide_-_Moodle_for_Windows_on_a_USB_Memory_Stick Installation guide - Moodle 1.9 for Windows on a USB Memory Stick]
*Return to [[Windows installation]]
*[[Windows 1 computer many servers |Multiple web servers, on 1 computer]] similar to windows installation page, with some tips
*[https://docs.moodle.org/en/Windows_installation_using_XAMPP#Troubleshooting Troubleshooting]if you are running Skype.
*[[Installing_AMP]] lots of XAMPP stuff. XAMPP stands for X (cross platform), Apache, MySQL,PHP and Perl. XAMPP used in Moodle does not include Perl. MAMP stands for Mac, Apache, MySQL and PHP.
*[[Installation Package for OS X]]

[[es:Paquetes para Instalación Completa para Windows]]
[[pl:Kompletne pakiety instalacyjne]]
[[de:Vollständiges Installationspaket für Windows]]

[[Category:Installation]]
[[Category:Windows]]

Installing MSSQL for PHP

2016-09-14T09:34:55Z

Stronk7: Added note about PHP 7 and this driver status.

{{Installing Moodle}}== Introduction ==

This short manual is suitable if you are trying to run Moodle using the SQL*Server (MSSQL) RDBMS. Steps detailed below must be performed '''before''' installing Moodle itself.

Some of this may also apply if you wish to access an MSSQL server for external db authentication/enrollment.

First of all, minimum required version of MSSQL has been stabilised to MSSQL 2005 (v.9).

While PHP comes with one, more or less, standard extension (mssql) that provides access to MSSQL databases, early we found some hard limits on it. Basically such default extension has some limits that prevent us to use it at all (you can find more info about these problems [[Development:XMLDB problems#MSSQL, PHP, UTF-8 and UCS-2|here]]).

So, in order to allow PHP (i.e. Moodle) to access to MSSQL DBs properly we have to install a '''mssql extension alternative''' to save us from the problems related above. See the sections below for details about the various options.

== Installation overview ==

1. Get MSSQL Server installed and running. ([http://www.microsoft.com/sql/editions/express/default.mspx A free limited version, SQL Server Express Edition] is available for testing.)
:Make sure that you choose mixed authentication (Windows and local accounts) to keep things simpler later. You'll be asked to define the "sa" account password (it's the default System Administrator account which has full access to all databases by default).

2. Make sure MS SQL Server can accept incoming TCP/IP connections on port 1433 (the standard one).
:You might need to explicitly allow this in your Windows firewall (see the Control Panel). You may also need to edit options in the :'''SQL Server Configuration Manager''' -> '''Network Configuration''' -> '''Protocols''' -> '''TCP/IP enabled'''

3. Open the "SQL Server Management Studio" and create a new empty database. If you are using the "sa" account then you don't need to do anything else here.

4. Configure these settings in your created (and still empty) database:
Configure these settings in your created (and still empty) database:
:*Use a case sensitive collation, such as Latin1_General_CS_AS.
:*ANSI NULLS Enabled = True (ALTER DATABASE xxxx SET ANSI_NULLS ON)
:*Quoted Identifiers Enabled = True (ALTER DATABASE xxxx SET QUOTED_IDENTIFIER ON)
:*Is Read Committed transaction ON = True (ALTER DATABASE xxxx SET READ_COMMITTED_SNAPSHOT ON)
:** In older versions this is not settable via the DB properties. To set READ_COMMITTED_SNAPSHOT, there must be no active connections to the database except for the connection executing the ALTER command. If you are viewing the DB in the Server Management Studio, disconnect from any servers in the "Object Explorer" (right-click > Disconnect), then create a "New Query" and run the ALTER command. See http://msdn.microsoft.com/en-us/library/bb522682.aspx for details.
:** If your DB name starts with a number, you may need to put quotes around the DB name in the query.

5. Get PHP installed with a web server. Unless you want to do it under IIS or some other way, the packages on the [http://download.moodle.org Moodle download page] are a good solution.

6. Choose one of the following specific sections for your server to install the '''mssql extension alternative''' installed and running properly on your PHP box.

7. Set the following settings in your php.ini file
:* mssql.textlimit = 20971520
:* mssql.textsize = 20971520

8. With all this properly configured, you can continue with a [[Installing Moodle|standard Moodle installation]].

== Microsoft Drivers for SQL Server for PHP ==

In July 2008 Microsoft [http://social.msdn.microsoft.com/forums/en-US/sqldriverforphp/thread/a10e5202-9e41-4ff8-a33e-fbcc7b951be2/ released] a new SQL Server Driver for PHP. This is a PHP extension that allows PHP scripts to read and write data on Microsoft SQL Server databases and it overcomes the problems with the native SQL Server extension that was previously bundled with PHP.

When using [[IIS]] it is strongly recommended to use the official Microsoft PHP installer from http://php.iis.net/, it should include the latest version of necessary drivers and it also simplifies future upgrades and configuration.

For Windows servers with [[Apache]] see http://www.microsoft.com/en-us/download/details.aspx?id=20098.

To know more about how to run Moodle with these drivers go to [[Using the Microsoft SQL Server Driver for PHP]].

== Using FreeTDS on Windows ==

'''Important Note 1:''' Due to some previous bugs it's highly recommendable to use PHP >= 5.2.6 and FreeTDS 0.82 + post-release patches ([http://tracker.moodle.org/browse/MDL-14725 more info]).
'''Important Note 2:''' PHP 7 and following do not support the php_mssql driver [http://php.net/manual/en/intro.mssql.php anymore]. People wanting to use SQL*Server database services should switch to the [[Using_the_Microsoft_SQL_Server_Driver_for_PHP|sqlsrv drivers]] in the platforms were they are available or keep using PHP 5.6.x

If your web server is on Windows, use '''php_dblib.dll'''. Despite the name, it's FreeTDS compiled for Windows. (Go to this page for information on [https://docs.moodle.org/en/FreeTDS Using FreeTDS for Unix].)

Originally we were using the DLLs available at [http://kromann.info/article.php?Id=11062598797760000 Frank Kromann's site], but they are outdated (using old versions of FreeTDS) and that has caused [http://tracker.moodle.org/browse/MDL-14725 some problems] in the past.

So, right now, the recommended way to use FreeTDS under Windows is to use PHP 5.2.x following the following instructions:

1. Download the appropriate copy of php_dblib.dll from the list below, and save it into your /PHP/ext directory.

{| class="table table-striped table-bordered"
|-
! PHP version !! [http://www.iis-aid.com/articles/my_word/difference_between_php_thread_safe_and_non_thread_safe_binaries Thread Safe] !! FreeTDS version !! Download URL
|-
| PHP 5.6.x (vc11-unkown architecture) || Both || 0.95 || You can find some (unverified/untested) drivers in [https://moodle.org/mod/forum/discuss.php?d=232844#p1297504 this forum post], courtesy of Josh Urbain.
|-
| colspan="4" | Thanks to [http://remote-learner.net/ Remote-Learner]] (Moodle [http://moodle.com/partners/ Partner]) and specially to Bryan Williams, donating one Visual C++ 6.0 Pro license to Moodle. Thanks to Trevor Johnson and his builds of the dblib extensions. Thanks to Daniele, Doug, Luis, Sean and many others by their collaboration in MDL-14725. Thanks to Frediano Ziglio and James K. Lowden from [http://freetds.org freetds.org] by their support. Thanks to [[User:Alastair Hole|Alastair Hole]] and Matt Rusiniak for providing the PHP 5.3 builds of the libraries. Thanks to Enyby by providing the PHP 5.4 builds of the libraries. Thanks to David Aylmer and Matt Rusiniak for providing the PHP 5.5 builds of the libraries. Thanks!
|}

For versions of the DLLs working with older PHP engines, you can visit [https://docs.moodle.org/30/en/Installing_MSSQL_for_PHP this page for previous Moodle releases].

(alternatively here you can find some [[Development:Compiling FreeTDS under Windows|instructions to build those freetds extensions under win32]] yourself).

2. FreeTDS requires the .NET Framework v1.1 to be installed. You can [http://www.microsoft.com/downloads/details.aspx?FamilyID=262d25e3-f589-4842-8157-034d1e7cf3a3&DisplayLang=en download it from the Microsoft website] along with its [http://www.microsoft.com/downloads/details.aspx?FamilyID=a8f5654f-088e-40b2-bbdb-a83353618b38&DisplayLang=en service pack]. Alternatively, if you do not wish to install this framework, you can [http://kromann.info/ms-libs/msvcr71.dll download the required DLL] from Frank's site, and save it into your /PHP root directory.

3. Edit your /PHP/php.ini file and add this line:

extension=php_dblib.dll

Make sure that any lines referring to the php_mssql.dll extension are DISABLED (commented out).

4. When the PHP engine loads the FreeTDS extension it needs to be passed certain infiormation in order to be able to connect to your Moodle database. To retrieve this information FreeTDS looks for a file called '''freetds.conf''' in the root folder of the server that PHP installed on (e.g. C:\).

'''freetds.conf''' should have the following structure:

[global]
host = xxx.xxx.xxx.xxx (host name or ip of the MSSQL server)
port = 1433
client charset = UTF-8
tds version = 8.0
text size = 20971520

If you want to connect to a particular [http://msdn.microsoft.com/en-us/library/aa174516(SQL.80).aspx instance] of MSSQL you should specify the instance name:

[global]
host = xxx.xxx.xxx.xxx (host name or ip of the MSSQL server)
instance = xxx (instance name, e.g. INST2)
port = 1433
client charset = UTF-8
tds version = 8.0
text size = 20971520

'''Notes:'''
*You can configure FreeTDS to look for the freetds.conf file in any directory that you want - you don't have to use C:\. To do this create a SYSTEM environment variable called '''FREETDS''' and point it to the directory where you have installed the freetds.conf file. If you do not set this environment variable FreeTDS will look for the freetds.conf file in the C:\ folder, which is the default. One possible benefit of setting the FREETDS environment variable and using a different installation directory for freetds.conf is that C:\ is very predictable to a hacker that knows anything about FreeTDS and that is the first place that he would look if he wanted to compromise your system. So, using a different installation directory would just make your system stronger. See the FreeTDS [http://www.freetds.org/userguide/envvar.htm Setting the environment variables] documentation for more information about this FREETDS environment variable.

*Alternatively, you can [[Development:Compiling FreeTDS under Windows|recompile]] the FreeTDS extension yourself and change the default location to your preferred location at compile time. Then it is not necessary to create any environment variable. You must just ensure that freetds.conf is in the same folder that you specify when you compile php_dblib.dll.

*MSSQL is usually installed with port 1433 as the default. However, if the port was changed on your server when you installed MSSQL then you need to specify the correct port number.

5. Your Moodle '''config.php''' should include lines like these:

<code php>
$CFG->dbtype = 'mssql'; // Required
$CFG->dbhost = 'localhost'; // assuming MS SQL is on the same server, otherwise use an IP
$CFG->dbname = 'moodle'; // or whatever you called the database you created
$CFG->dbuser = 'yourusername'; // I usually use the 'sa' account (dbowner perms are enough)
$CFG->dbpass = 'yourpassword';
$CFG->dbpersist = false;
$CFG->prefix = 'mdl_'; //Prefix, you can change it, but NEVER leave it blank.
</code>

If you don't have a config.php file yet, it can be generated as normal from the Moodle installer. Alternatively you can use the config-dist.php file that comes with the Moodle package to create your own config.php file.

6. Restart or start your web server. If Moodle still cannot communicate with the database server, please turn display_startup_errors to "On" in your /PHP/php.ini file, then restart the web server and check for any errors that may indicate incorrect DLL versions or missing dependencies. These error reports, turned off by default in PHP, can be vital in locating a problem with new extension installations.

7. Database conection test, try this PHP script, just put in a text file called test.php change ('localhost', 'db_user', 'db_password') to suite your setup, and load from local host (http://localhost/test.php)...

<code php>
<?php
$link = mssql_connect('localhost', 'db_user', 'db_password');
if(!$link) {
echo'Could not connect';
die('Could not connect: ' . mssql_error());
}
echo'Successful connection';
mssql_close($link);
?>
</code>

8. Install Moodle as usual. Good luck!

=== Troubleshooting ===
If you encounter some problems you can try:
*check that you have DotNet framework 1.1 installed (later version are installed on Vista, but you could need this specific one) 
*enable TCP/IP for MSSQL: SQL Server 2005 Network Configuration -> Protocols for MSSQLSERVER -> TCP/IP (Enable) -> Properties -> Ip Addresses -> 127.0.0.1 (Active+Enable) 
*make sure the SQL Server Browser service is running SQL Server 2005 Network Configuration -> SQL Server Services 
*if you are using SQL Server 2005 and you have the error ''4004: Unicode data in a Unicode-only collation or ntext data cannot be sent to clients using DB-Library (such as ISQL) or ODBC version 3.7 or earlier'', try the ODBTP method (next chapter). The SQL Server complaining that it doesn't support pure Unicode via TDS or older versions of ODBC. Microsoft has deprecated DB-Library a long ago, in favor of ODBC, OLE DB, or SQL Native Client. Many new features of SQL 2005 aren't accessible via DB-Library so if you need them, you could have to switch away from tools based on TDS and DB-Library :(

== FreeTDS on Linux (on Ubuntu by compiling an mssql.so extension) ==
This is a good read to [http://www.robert-gonzalez.com/2009/02/18/building-the-php-ms-sql-server-extension-from-source-on-ubuntu-810/ building a FreeTDS based mssql extension for apache on Ubuntu]. Do note that [http://www.freetds.org/news.html freeTDS] 0.91 was recently released, you can find latest versions [http://freetds.sourceforge.net/ here].

Note: the freetds.conf file you use should have "text size = 20971520" as mentioned in the FreeTDS on Windows section otherwise you might see sessions logging out or worse apache segmentation faults. Also see [[FreeTDS]].

Note2: Please note that updating php tends to remove the freetds configurations. You might need to reconfigure freetds after an upgrade

== Using FreeTDS on Debian Lenny ==
I found the following solution using:
* PHP Version 5.2.6-1+lenny9
* Microsoft SQL Server Enterprise Edition, version: 9.00.4053.00
<pre>apt-get install libsybdb5 freetds-common php5-sybase
/etc/init.d/apache2 restart</pre>
At the end of the process, if all goes fine, you will find in the mssql section of phpinfo();

{| class="nicetable"
|-
! MSSQL Support
! enabled
|-
| Library version
| FreeTDS
|}

Once FreeTDS is correctly installed, don not forget to set it up following explanations in https://docs.moodle.org/en/FreeTDS

== See also ==
* [[Errors FAQ]]
* Using Moodle [http://moodle.org/mod/forum/view.php?id=28 Installation problems forum]

[[Category:XMLDB]]
[[Category:DB]]
[[Category:SQL databases]]

Installing MSSQL for PHP

2016-09-14T09:27:13Z

Stronk7: typo!

{{Installing Moodle}}== Introduction ==

This short manual is suitable if you are trying to run Moodle using the SQL*Server (MSSQL) RDBMS. Steps detailed below must be performed '''before''' installing Moodle itself.

Some of this may also apply if you wish to access an MSSQL server for external db authentication/enrollment.

First of all, minimum required version of MSSQL has been stabilised to MSSQL 2005 (v.9).

While PHP comes with one, more or less, standard extension (mssql) that provides access to MSSQL databases, early we found some hard limits on it. Basically such default extension has some limits that prevent us to use it at all (you can find more info about these problems [[Development:XMLDB problems#MSSQL, PHP, UTF-8 and UCS-2|here]]).

So, in order to allow PHP (i.e. Moodle) to access to MSSQL DBs properly we have to install a '''mssql extension alternative''' to save us from the problems related above. See the sections below for details about the various options.

== Installation overview ==

1. Get MSSQL Server installed and running. ([http://www.microsoft.com/sql/editions/express/default.mspx A free limited version, SQL Server Express Edition] is available for testing.)
:Make sure that you choose mixed authentication (Windows and local accounts) to keep things simpler later. You'll be asked to define the "sa" account password (it's the default System Administrator account which has full access to all databases by default).

2. Make sure MS SQL Server can accept incoming TCP/IP connections on port 1433 (the standard one).
:You might need to explicitly allow this in your Windows firewall (see the Control Panel). You may also need to edit options in the :'''SQL Server Configuration Manager''' -> '''Network Configuration''' -> '''Protocols''' -> '''TCP/IP enabled'''

3. Open the "SQL Server Management Studio" and create a new empty database. If you are using the "sa" account then you don't need to do anything else here.

4. Configure these settings in your created (and still empty) database:
Configure these settings in your created (and still empty) database:
:*Use a case sensitive collation, such as Latin1_General_CS_AS.
:*ANSI NULLS Enabled = True (ALTER DATABASE xxxx SET ANSI_NULLS ON)
:*Quoted Identifiers Enabled = True (ALTER DATABASE xxxx SET QUOTED_IDENTIFIER ON)
:*Is Read Committed transaction ON = True (ALTER DATABASE xxxx SET READ_COMMITTED_SNAPSHOT ON)
:** In older versions this is not settable via the DB properties. To set READ_COMMITTED_SNAPSHOT, there must be no active connections to the database except for the connection executing the ALTER command. If you are viewing the DB in the Server Management Studio, disconnect from any servers in the "Object Explorer" (right-click > Disconnect), then create a "New Query" and run the ALTER command. See http://msdn.microsoft.com/en-us/library/bb522682.aspx for details.
:** If your DB name starts with a number, you may need to put quotes around the DB name in the query.

5. Get PHP installed with a web server. Unless you want to do it under IIS or some other way, the packages on the [http://download.moodle.org Moodle download page] are a good solution.

6. Choose one of the following specific sections for your server to install the '''mssql extension alternative''' installed and running properly on your PHP box.

7. Set the following settings in your php.ini file
:* mssql.textlimit = 20971520
:* mssql.textsize = 20971520

8. With all this properly configured, you can continue with a [[Installing Moodle|standard Moodle installation]].

== Microsoft Drivers for SQL Server for PHP ==

In July 2008 Microsoft [http://social.msdn.microsoft.com/forums/en-US/sqldriverforphp/thread/a10e5202-9e41-4ff8-a33e-fbcc7b951be2/ released] a new SQL Server Driver for PHP. This is a PHP extension that allows PHP scripts to read and write data on Microsoft SQL Server databases and it overcomes the problems with the native SQL Server extension that was previously bundled with PHP.

When using [[IIS]] it is strongly recommended to use the official Microsoft PHP installer from http://php.iis.net/, it should include the latest version of necessary drivers and it also simplifies future upgrades and configuration.

For Windows servers with [[Apache]] see http://www.microsoft.com/en-us/download/details.aspx?id=20098.

To know more about how to run Moodle with these drivers go to [[Using the Microsoft SQL Server Driver for PHP]].

== Using FreeTDS on Windows ==

'''Important Note 1:''' Due to some previous bugs it's highly recommendable to use PHP >= 5.2.6 and FreeTDS 0.82 + post-release patches ([http://tracker.moodle.org/browse/MDL-14725 more info]).

If your web server is on Windows, use '''php_dblib.dll'''. Despite the name, it's FreeTDS compiled for Windows. (Go to this page for information on [https://docs.moodle.org/en/FreeTDS Using FreeTDS for Unix].)

Originally we were using the DLLs available at [http://kromann.info/article.php?Id=11062598797760000 Frank Kromann's site], but they are outdated (using old versions of FreeTDS) and that has caused [http://tracker.moodle.org/browse/MDL-14725 some problems] in the past.

So, right now, the recommended way to use FreeTDS under Windows is to use PHP 5.2.x following the following instructions:

1. Download the appropriate copy of php_dblib.dll from the list below, and save it into your /PHP/ext directory.

{| class="table table-striped table-bordered"
|-
! PHP version !! [http://www.iis-aid.com/articles/my_word/difference_between_php_thread_safe_and_non_thread_safe_binaries Thread Safe] !! FreeTDS version !! Download URL
|-
| PHP 5.6.x (vc11-unkown architecture) || Both || 0.95 || You can find some (unverified/untested) drivers in [https://moodle.org/mod/forum/discuss.php?d=232844#p1297504 this forum post], courtesy of Josh Urbain.
|-
| colspan="4" | Thanks to [http://remote-learner.net/ Remote-Learner]] (Moodle [http://moodle.com/partners/ Partner]) and specially to Bryan Williams, donating one Visual C++ 6.0 Pro license to Moodle. Thanks to Trevor Johnson and his builds of the dblib extensions. Thanks to Daniele, Doug, Luis, Sean and many others by their collaboration in MDL-14725. Thanks to Frediano Ziglio and James K. Lowden from [http://freetds.org freetds.org] by their support. Thanks to [[User:Alastair Hole|Alastair Hole]] and Matt Rusiniak for providing the PHP 5.3 builds of the libraries. Thanks to Enyby by providing the PHP 5.4 builds of the libraries. Thanks to David Aylmer and Matt Rusiniak for providing the PHP 5.5 builds of the libraries. Thanks!
|}

For versions of the DLLs working with older PHP engines, you can visit [https://docs.moodle.org/30/en/Installing_MSSQL_for_PHP this page for previous Moodle releases].

(alternatively here you can find some [[Development:Compiling FreeTDS under Windows|instructions to build those freetds extensions under win32]] yourself).

2. FreeTDS requires the .NET Framework v1.1 to be installed. You can [http://www.microsoft.com/downloads/details.aspx?FamilyID=262d25e3-f589-4842-8157-034d1e7cf3a3&DisplayLang=en download it from the Microsoft website] along with its [http://www.microsoft.com/downloads/details.aspx?FamilyID=a8f5654f-088e-40b2-bbdb-a83353618b38&DisplayLang=en service pack]. Alternatively, if you do not wish to install this framework, you can [http://kromann.info/ms-libs/msvcr71.dll download the required DLL] from Frank's site, and save it into your /PHP root directory.

3. Edit your /PHP/php.ini file and add this line:

extension=php_dblib.dll

Make sure that any lines referring to the php_mssql.dll extension are DISABLED (commented out).

4. When the PHP engine loads the FreeTDS extension it needs to be passed certain infiormation in order to be able to connect to your Moodle database. To retrieve this information FreeTDS looks for a file called '''freetds.conf''' in the root folder of the server that PHP installed on (e.g. C:\).

'''freetds.conf''' should have the following structure:

[global]
host = xxx.xxx.xxx.xxx (host name or ip of the MSSQL server)
port = 1433
client charset = UTF-8
tds version = 8.0
text size = 20971520

If you want to connect to a particular [http://msdn.microsoft.com/en-us/library/aa174516(SQL.80).aspx instance] of MSSQL you should specify the instance name:

[global]
host = xxx.xxx.xxx.xxx (host name or ip of the MSSQL server)
instance = xxx (instance name, e.g. INST2)
port = 1433
client charset = UTF-8
tds version = 8.0
text size = 20971520

'''Notes:'''
*You can configure FreeTDS to look for the freetds.conf file in any directory that you want - you don't have to use C:\. To do this create a SYSTEM environment variable called '''FREETDS''' and point it to the directory where you have installed the freetds.conf file. If you do not set this environment variable FreeTDS will look for the freetds.conf file in the C:\ folder, which is the default. One possible benefit of setting the FREETDS environment variable and using a different installation directory for freetds.conf is that C:\ is very predictable to a hacker that knows anything about FreeTDS and that is the first place that he would look if he wanted to compromise your system. So, using a different installation directory would just make your system stronger. See the FreeTDS [http://www.freetds.org/userguide/envvar.htm Setting the environment variables] documentation for more information about this FREETDS environment variable.

*Alternatively, you can [[Development:Compiling FreeTDS under Windows|recompile]] the FreeTDS extension yourself and change the default location to your preferred location at compile time. Then it is not necessary to create any environment variable. You must just ensure that freetds.conf is in the same folder that you specify when you compile php_dblib.dll.

*MSSQL is usually installed with port 1433 as the default. However, if the port was changed on your server when you installed MSSQL then you need to specify the correct port number.

5. Your Moodle '''config.php''' should include lines like these:

<code php>
$CFG->dbtype = 'mssql'; // Required
$CFG->dbhost = 'localhost'; // assuming MS SQL is on the same server, otherwise use an IP
$CFG->dbname = 'moodle'; // or whatever you called the database you created
$CFG->dbuser = 'yourusername'; // I usually use the 'sa' account (dbowner perms are enough)
$CFG->dbpass = 'yourpassword';
$CFG->dbpersist = false;
$CFG->prefix = 'mdl_'; //Prefix, you can change it, but NEVER leave it blank.
</code>

If you don't have a config.php file yet, it can be generated as normal from the Moodle installer. Alternatively you can use the config-dist.php file that comes with the Moodle package to create your own config.php file.

6. Restart or start your web server. If Moodle still cannot communicate with the database server, please turn display_startup_errors to "On" in your /PHP/php.ini file, then restart the web server and check for any errors that may indicate incorrect DLL versions or missing dependencies. These error reports, turned off by default in PHP, can be vital in locating a problem with new extension installations.

7. Database conection test, try this PHP script, just put in a text file called test.php change ('localhost', 'db_user', 'db_password') to suite your setup, and load from local host (http://localhost/test.php)...

<code php>
<?php
$link = mssql_connect('localhost', 'db_user', 'db_password');
if(!$link) {
echo'Could not connect';
die('Could not connect: ' . mssql_error());
}
echo'Successful connection';
mssql_close($link);
?>
</code>

8. Install Moodle as usual. Good luck!

=== Troubleshooting ===
If you encounter some problems you can try:
*check that you have DotNet framework 1.1 installed (later version are installed on Vista, but you could need this specific one) 
*enable TCP/IP for MSSQL: SQL Server 2005 Network Configuration -> Protocols for MSSQLSERVER -> TCP/IP (Enable) -> Properties -> Ip Addresses -> 127.0.0.1 (Active+Enable) 
*make sure the SQL Server Browser service is running SQL Server 2005 Network Configuration -> SQL Server Services 
*if you are using SQL Server 2005 and you have the error ''4004: Unicode data in a Unicode-only collation or ntext data cannot be sent to clients using DB-Library (such as ISQL) or ODBC version 3.7 or earlier'', try the ODBTP method (next chapter). The SQL Server complaining that it doesn't support pure Unicode via TDS or older versions of ODBC. Microsoft has deprecated DB-Library a long ago, in favor of ODBC, OLE DB, or SQL Native Client. Many new features of SQL 2005 aren't accessible via DB-Library so if you need them, you could have to switch away from tools based on TDS and DB-Library :(

== FreeTDS on Linux (on Ubuntu by compiling an mssql.so extension) ==
This is a good read to [http://www.robert-gonzalez.com/2009/02/18/building-the-php-ms-sql-server-extension-from-source-on-ubuntu-810/ building a FreeTDS based mssql extension for apache on Ubuntu]. Do note that [http://www.freetds.org/news.html freeTDS] 0.91 was recently released, you can find latest versions [http://freetds.sourceforge.net/ here].

Note: the freetds.conf file you use should have "text size = 20971520" as mentioned in the FreeTDS on Windows section otherwise you might see sessions logging out or worse apache segmentation faults. Also see [[FreeTDS]].

Note2: Please note that updating php tends to remove the freetds configurations. You might need to reconfigure freetds after an upgrade

== Using FreeTDS on Debian Lenny ==
I found the following solution using:
* PHP Version 5.2.6-1+lenny9
* Microsoft SQL Server Enterprise Edition, version: 9.00.4053.00
<pre>apt-get install libsybdb5 freetds-common php5-sybase
/etc/init.d/apache2 restart</pre>
At the end of the process, if all goes fine, you will find in the mssql section of phpinfo();

{| class="nicetable"
|-
! MSSQL Support
! enabled
|-
| Library version
| FreeTDS
|}

Once FreeTDS is correctly installed, don not forget to set it up following explanations in https://docs.moodle.org/en/FreeTDS

== See also ==
* [[Errors FAQ]]
* Using Moodle [http://moodle.org/mod/forum/view.php?id=28 Installation problems forum]

[[Category:XMLDB]]
[[Category:DB]]
[[Category:SQL databases]]

Installing MSSQL for PHP

2016-09-14T09:24:39Z

Stronk7: Adding a link to previous docs (3.0) were the links to older extensions are available. People really downloads them.

{{Installing Moodle}}== Introduction ==

This short manual is suitable if you are trying to run Moodle using the SQL*Server (MSSQL) RDBMS. Steps detailed below must be performed '''before''' installing Moodle itself.

Some of this may also apply if you wish to access an MSSQL server for external db authentication/enrollment.

First of all, minimum required version of MSSQL has been stabilised to MSSQL 2005 (v.9).

While PHP comes with one, more or less, standard extension (mssql) that provides access to MSSQL databases, early we found some hard limits on it. Basically such default extension has some limits that prevent us to use it at all (you can find more info about these problems [[Development:XMLDB problems#MSSQL, PHP, UTF-8 and UCS-2|here]]).

So, in order to allow PHP (i.e. Moodle) to access to MSSQL DBs properly we have to install a '''mssql extension alternative''' to save us from the problems related above. See the sections below for details about the various options.

== Installation overview ==

1. Get MSSQL Server installed and running. ([http://www.microsoft.com/sql/editions/express/default.mspx A free limited version, SQL Server Express Edition] is available for testing.)
:Make sure that you choose mixed authentication (Windows and local accounts) to keep things simpler later. You'll be asked to define the "sa" account password (it's the default System Administrator account which has full access to all databases by default).

2. Make sure MS SQL Server can accept incoming TCP/IP connections on port 1433 (the standard one).
:You might need to explicitly allow this in your Windows firewall (see the Control Panel). You may also need to edit options in the :'''SQL Server Configuration Manager''' -> '''Network Configuration''' -> '''Protocols''' -> '''TCP/IP enabled'''

3. Open the "SQL Server Management Studio" and create a new empty database. If you are using the "sa" account then you don't need to do anything else here.

4. Configure these settings in your created (and still empty) database:
Configure these settings in your created (and still empty) database:
:*Use a case sensitive collation, such as Latin1_General_CS_AS.
:*ANSI NULLS Enabled = True (ALTER DATABASE xxxx SET ANSI_NULLS ON)
:*Quoted Identifiers Enabled = True (ALTER DATABASE xxxx SET QUOTED_IDENTIFIER ON)
:*Is Read Committed transaction ON = True (ALTER DATABASE xxxx SET READ_COMMITTED_SNAPSHOT ON)
:** In older versions this is not settable via the DB properties. To set READ_COMMITTED_SNAPSHOT, there must be no active connections to the database except for the connection executing the ALTER command. If you are viewing the DB in the Server Management Studio, disconnect from any servers in the "Object Explorer" (right-click > Disconnect), then create a "New Query" and run the ALTER command. See http://msdn.microsoft.com/en-us/library/bb522682.aspx for details.
:** If your DB name starts with a number, you may need to put quotes around the DB name in the query.

5. Get PHP installed with a web server. Unless you want to do it under IIS or some other way, the packages on the [http://download.moodle.org Moodle download page] are a good solution.

6. Choose one of the following specific sections for your server to install the '''mssql extension alternative''' installed and running properly on your PHP box.

7. Set the following settings in your php.ini file
:* mssql.textlimit = 20971520
:* mssql.textsize = 20971520

8. With all this properly configured, you can continue with a [[Installing Moodle|standard Moodle installation]].

== Microsoft Drivers for SQL Server for PHP ==

In July 2008 Microsoft [http://social.msdn.microsoft.com/forums/en-US/sqldriverforphp/thread/a10e5202-9e41-4ff8-a33e-fbcc7b951be2/ released] a new SQL Server Driver for PHP. This is a PHP extension that allows PHP scripts to read and write data on Microsoft SQL Server databases and it overcomes the problems with the native SQL Server extension that was previously bundled with PHP.

When using [[IIS]] it is strongly recommended to use the official Microsoft PHP installer from http://php.iis.net/, it should include the latest version of necessary drivers and it also simplifies future upgrades and configuration.

For Windows servers with [[Apache]] see http://www.microsoft.com/en-us/download/details.aspx?id=20098.

To know more about how to run Moodle with these drivers go to [[Using the Microsoft SQL Server Driver for PHP]].

== Using FreeTDS on Windows ==

'''Important Note 1:''' Due to some previous bugs it's highly recommendable to use PHP >= 5.2.6 and FreeTDS 0.82 + post-release patches ([http://tracker.moodle.org/browse/MDL-14725 more info]).

If your web server is on Windows, use '''php_dblib.dll'''. Despite the name, it's FreeTDS compiled for Windows. (Go to this page for information on [https://docs.moodle.org/en/FreeTDS Using FreeTDS for Unix].)

Originally we were using the DLLs available at [http://kromann.info/article.php?Id=11062598797760000 Frank Kromann's site], but they are outdated (using old versions of FreeTDS) and that has caused [http://tracker.moodle.org/browse/MDL-14725 some problems] in the past.

So, right now, the recommended way to use FreeTDS under Windows is to use PHP 5.2.x following the following instructions:

1. Download the appropriate copy of php_dblib.dll from the list below, and save it into your /PHP/ext directory.

{| class="table table-striped table-bordered"
|-
! PHP version !! [http://www.iis-aid.com/articles/my_word/difference_between_php_thread_safe_and_non_thread_safe_binaries Thread Safe] !! FreeTDS version !! Download URL
|-
| PHP 5.6.x (vc11-unkown architecture) || Both || 0.95 || You can find some (unverified/untested) drivers in [https://moodle.org/mod/forum/discuss.php?d=232844#p1297504 this forum post], courtesy of Josh Urbain.
|-
| colspan="4" | Thanks to [http://remote-learner.net/ Remote-Learner]] (Moodle [http://moodle.com/partners/ Partner]) and specially to Bryan Williams, donating one Visual C++ 6.0 Pro license to Moodle. Thanks to Trevor Johnson and his builds of the dblib extensions. Thanks to Daniele, Doug, Luis, Sean and many others by their collaboration in MDL-14725. Thanks to Frediano Ziglio and James K. Lowden from [http://freetds.org freetds.org] by their support. Thanks to [[User:Alastair Hole|Alastair Hole]] and Matt Rusiniak for providing the PHP 5.3 builds of the libraries. Thanks to Enyby by providing the PHP 5.4 builds of the libraries. Thanks to David Aylmer and Matt Rusiniak for providing the PHP 5.5 builds of the libraries. Thanks!
|}

For versions of the DLLs working with older PHP engines, you can visit [https://docs.moodle.org/30/en/Installing_MSSQL_for_PHP this page for previous Moodle relases].

(alternatively here you can find some [[Development:Compiling FreeTDS under Windows|instructions to build those freetds extensions under win32]] yourself).

2. FreeTDS requires the .NET Framework v1.1 to be installed. You can [http://www.microsoft.com/downloads/details.aspx?FamilyID=262d25e3-f589-4842-8157-034d1e7cf3a3&DisplayLang=en download it from the Microsoft website] along with its [http://www.microsoft.com/downloads/details.aspx?FamilyID=a8f5654f-088e-40b2-bbdb-a83353618b38&DisplayLang=en service pack]. Alternatively, if you do not wish to install this framework, you can [http://kromann.info/ms-libs/msvcr71.dll download the required DLL] from Frank's site, and save it into your /PHP root directory.

3. Edit your /PHP/php.ini file and add this line:

extension=php_dblib.dll

Make sure that any lines referring to the php_mssql.dll extension are DISABLED (commented out).

4. When the PHP engine loads the FreeTDS extension it needs to be passed certain infiormation in order to be able to connect to your Moodle database. To retrieve this information FreeTDS looks for a file called '''freetds.conf''' in the root folder of the server that PHP installed on (e.g. C:\).

'''freetds.conf''' should have the following structure:

[global]
host = xxx.xxx.xxx.xxx (host name or ip of the MSSQL server)
port = 1433
client charset = UTF-8
tds version = 8.0
text size = 20971520

If you want to connect to a particular [http://msdn.microsoft.com/en-us/library/aa174516(SQL.80).aspx instance] of MSSQL you should specify the instance name:

[global]
host = xxx.xxx.xxx.xxx (host name or ip of the MSSQL server)
instance = xxx (instance name, e.g. INST2)
port = 1433
client charset = UTF-8
tds version = 8.0
text size = 20971520

'''Notes:'''
*You can configure FreeTDS to look for the freetds.conf file in any directory that you want - you don't have to use C:\. To do this create a SYSTEM environment variable called '''FREETDS''' and point it to the directory where you have installed the freetds.conf file. If you do not set this environment variable FreeTDS will look for the freetds.conf file in the C:\ folder, which is the default. One possible benefit of setting the FREETDS environment variable and using a different installation directory for freetds.conf is that C:\ is very predictable to a hacker that knows anything about FreeTDS and that is the first place that he would look if he wanted to compromise your system. So, using a different installation directory would just make your system stronger. See the FreeTDS [http://www.freetds.org/userguide/envvar.htm Setting the environment variables] documentation for more information about this FREETDS environment variable.

*Alternatively, you can [[Development:Compiling FreeTDS under Windows|recompile]] the FreeTDS extension yourself and change the default location to your preferred location at compile time. Then it is not necessary to create any environment variable. You must just ensure that freetds.conf is in the same folder that you specify when you compile php_dblib.dll.

*MSSQL is usually installed with port 1433 as the default. However, if the port was changed on your server when you installed MSSQL then you need to specify the correct port number.

5. Your Moodle '''config.php''' should include lines like these:

<code php>
$CFG->dbtype = 'mssql'; // Required
$CFG->dbhost = 'localhost'; // assuming MS SQL is on the same server, otherwise use an IP
$CFG->dbname = 'moodle'; // or whatever you called the database you created
$CFG->dbuser = 'yourusername'; // I usually use the 'sa' account (dbowner perms are enough)
$CFG->dbpass = 'yourpassword';
$CFG->dbpersist = false;
$CFG->prefix = 'mdl_'; //Prefix, you can change it, but NEVER leave it blank.
</code>

If you don't have a config.php file yet, it can be generated as normal from the Moodle installer. Alternatively you can use the config-dist.php file that comes with the Moodle package to create your own config.php file.

6. Restart or start your web server. If Moodle still cannot communicate with the database server, please turn display_startup_errors to "On" in your /PHP/php.ini file, then restart the web server and check for any errors that may indicate incorrect DLL versions or missing dependencies. These error reports, turned off by default in PHP, can be vital in locating a problem with new extension installations.

7. Database conection test, try this PHP script, just put in a text file called test.php change ('localhost', 'db_user', 'db_password') to suite your setup, and load from local host (http://localhost/test.php)...

<code php>
<?php
$link = mssql_connect('localhost', 'db_user', 'db_password');
if(!$link) {
echo'Could not connect';
die('Could not connect: ' . mssql_error());
}
echo'Successful connection';
mssql_close($link);
?>
</code>

8. Install Moodle as usual. Good luck!

=== Troubleshooting ===
If you encounter some problems you can try:
*check that you have DotNet framework 1.1 installed (later version are installed on Vista, but you could need this specific one) 
*enable TCP/IP for MSSQL: SQL Server 2005 Network Configuration -> Protocols for MSSQLSERVER -> TCP/IP (Enable) -> Properties -> Ip Addresses -> 127.0.0.1 (Active+Enable) 
*make sure the SQL Server Browser service is running SQL Server 2005 Network Configuration -> SQL Server Services 
*if you are using SQL Server 2005 and you have the error ''4004: Unicode data in a Unicode-only collation or ntext data cannot be sent to clients using DB-Library (such as ISQL) or ODBC version 3.7 or earlier'', try the ODBTP method (next chapter). The SQL Server complaining that it doesn't support pure Unicode via TDS or older versions of ODBC. Microsoft has deprecated DB-Library a long ago, in favor of ODBC, OLE DB, or SQL Native Client. Many new features of SQL 2005 aren't accessible via DB-Library so if you need them, you could have to switch away from tools based on TDS and DB-Library :(

== FreeTDS on Linux (on Ubuntu by compiling an mssql.so extension) ==
This is a good read to [http://www.robert-gonzalez.com/2009/02/18/building-the-php-ms-sql-server-extension-from-source-on-ubuntu-810/ building a FreeTDS based mssql extension for apache on Ubuntu]. Do note that [http://www.freetds.org/news.html freeTDS] 0.91 was recently released, you can find latest versions [http://freetds.sourceforge.net/ here].

Note: the freetds.conf file you use should have "text size = 20971520" as mentioned in the FreeTDS on Windows section otherwise you might see sessions logging out or worse apache segmentation faults. Also see [[FreeTDS]].

Note2: Please note that updating php tends to remove the freetds configurations. You might need to reconfigure freetds after an upgrade

== Using FreeTDS on Debian Lenny ==
I found the following solution using:
* PHP Version 5.2.6-1+lenny9
* Microsoft SQL Server Enterprise Edition, version: 9.00.4053.00
<pre>apt-get install libsybdb5 freetds-common php5-sybase
/etc/init.d/apache2 restart</pre>
At the end of the process, if all goes fine, you will find in the mssql section of phpinfo();

{| class="nicetable"
|-
! MSSQL Support
! enabled
|-
| Library version
| FreeTDS
|}

Once FreeTDS is correctly installed, don not forget to set it up following explanations in https://docs.moodle.org/en/FreeTDS

== See also ==
* [[Errors FAQ]]
* Using Moodle [http://moodle.org/mod/forum/view.php?id=28 Installation problems forum]

[[Category:XMLDB]]
[[Category:DB]]
[[Category:SQL databases]]

Talk:PostgreSQL

2016-08-04T17:18:53Z

Stronk7:

== Client Authentication Section ==

I've added a section called 'Client Authentication' to the bottom of the page, with instructions on adding an entry to 'pg_hba.conf'. I thought this was useful for people who aren't familiar with Postgres, as it will be an unfamiliar step to anyone with a background in MySQL.

After six years of looking after Moodle with a MySQL setup, I had to set up my first PostgreSQL server yesterday, and this is something that stumped me for a while. If these instructions can save somebody else a bit of time, they're probably a good thing.

--[[User:Alex Walker 2|Alex Walker 2]] ([[User talk:Alex Walker 2|talk]]) 18:16, 4 August 2016 (AWST)

: Thanks Alex! --[[User:Eloy Lafuente (stronk7)|Eloy Lafuente (stronk7)]] ([[User talk:Eloy Lafuente (stronk7)|talk]]) 01:18, 5 August 2016 (AWST)

Installing MSSQL for PHP

2016-07-25T15:46:39Z

Stronk7: Adding PHP 5.6 mssql candidate module link

{{Installing Moodle}}== Introduction ==

This short manual is suitable if you are trying to run Moodle using the SQL*Server (MSSQL) RDBMS. Steps detailed below must be performed '''before''' installing Moodle itself.

Some of this may also apply if you wish to access an MSSQL server for external db authentication/enrollment.

First of all, minimum required version of MSSQL has been stabilised to MSSQL 2005 (v.9).

While PHP comes with one, more or less, standard extension (mssql) that provides access to MSSQL databases, early we found some hard limits on it. Basically such default extension has some limits that prevent us to use it at all (you can find more info about these problems [[Development:XMLDB problems#MSSQL, PHP, UTF-8 and UCS-2|here]]).

So, in order to allow PHP (i.e. Moodle) to access to MSSQL DBs properly we have to install a '''mssql extension alternative''' to save us from the problems related above. See the sections below for details about the various options.

== Installation overview ==

1. Get MSSQL Server installed and running. ([http://www.microsoft.com/sql/editions/express/default.mspx A free limited version, SQL Server Express Edition] is available for testing.)
:Make sure that you choose mixed authentication (Windows and local accounts) to keep things simpler later. You'll be asked to define the "sa" account password (it's the default System Administrator account which has full access to all databases by default).

2. Make sure MS SQL Server can accept incoming TCP/IP connections on port 1433 (the standard one).
:You might need to explicitly allow this in your Windows firewall (see the Control Panel). You may also need to edit options in the :'''SQL Server Configuration Manager''' -> '''Network Configuration''' -> '''Protocols''' -> '''TCP/IP enabled'''

3. Open the "SQL Server Management Studio" and create a new empty database. If you are using the "sa" account then you don't need to do anything else here.

4. Configure these settings in your created (and still empty) database:
Configure these settings in your created (and still empty) database:
:*Use a case sensitive collation, such as Latin1_General_CS_AS.
:*ANSI NULLS Enabled = True (ALTER DATABASE xxxx SET ANSI_NULLS ON)
:*Quoted Identifiers Enabled = True (ALTER DATABASE xxxx SET QUOTED_IDENTIFIER ON)
:*Is Read Committed transaction ON = True (ALTER DATABASE xxxx SET READ_COMMITTED_SNAPSHOT ON)
:** In older versions this is not settable via the DB properties. To set READ_COMMITTED_SNAPSHOT, there must be no active connections to the database except for the connection executing the ALTER command. If you are viewing the DB in the Server Management Studio, disconnect from any servers in the "Object Explorer" (right-click > Disconnect), then create a "New Query" and run the ALTER command. See http://msdn.microsoft.com/en-us/library/bb522682.aspx for details.
:** If your DB name starts with a number, you may need to put quotes around the DB name in the query.

5. Get PHP installed with a web server. Unless you want to do it under IIS or some other way, the packages on the [http://download.moodle.org Moodle download page] are a good solution.

6. Choose one of the following specific sections for your server to install the '''mssql extension alternative''' installed and running properly on your PHP box.

7. Set the following settings in your php.ini file
:* mssql.textlimit = 20971520
:* mssql.textsize = 20971520

8. With all this properly configured, you can continue with a [[Installing Moodle|standard Moodle installation]].

== Microsoft Drivers for SQL Server for PHP ==

In July 2008 Microsoft [http://social.msdn.microsoft.com/forums/en-US/sqldriverforphp/thread/a10e5202-9e41-4ff8-a33e-fbcc7b951be2/ released] a new SQL Server Driver for PHP. This is a PHP extension that allows PHP scripts to read and write data on Microsoft SQL Server databases and it overcomes the problems with the native SQL Server extension that was previously bundled with PHP.

When using [[IIS]] it is strongly recommended to use the official Microsoft PHP installer from http://php.iis.net/, it should include the latest version of necessary drivers and it also simplifies future upgrades and configuration.

For Windows servers with [[Apache]] see http://www.microsoft.com/en-us/download/details.aspx?id=20098.

To know more about how to run Moodle with these drivers go to [[Using the Microsoft SQL Server Driver for PHP]].

== Using FreeTDS on Windows ==

'''Important Note 1:''' Due to some previous bugs it's highly recommendable to use PHP >= 5.2.6 and FreeTDS 0.82 + post-release patches ([http://tracker.moodle.org/browse/MDL-14725 more info]).

If your web server is on Windows, use '''php_dblib.dll'''. Despite the name, it's FreeTDS compiled for Windows. (Go to this page for information on [https://docs.moodle.org/en/FreeTDS Using FreeTDS for Unix].)

Originally we were using the DLLs available at [http://kromann.info/article.php?Id=11062598797760000 Frank Kromann's site], but they are outdated (using old versions of FreeTDS) and that has caused [http://tracker.moodle.org/browse/MDL-14725 some problems] in the past.

So, right now, the recommended way to use FreeTDS under Windows is to use PHP 5.2.x following the following instructions:

1. Download the appropriate copy of php_dblib.dll from the list below, and save it into your /PHP/ext directory.

{| class="table table-striped table-bordered"
|-
! PHP version !! [http://www.iis-aid.com/articles/my_word/difference_between_php_thread_safe_and_non_thread_safe_binaries Thread Safe] !! FreeTDS version !! Download URL
|-
| rowspan="2" | PHP 5.2.x (vc6) || Yes || 0.82 + 20090302 patches || [http://download.moodle.org/download.php/dblib/php52/DBLIB_TS.zip Download!]
|-
| No || 0.82 + 20090302 patches || [http://download.moodle.org/download.php/dblib/php52/DBLIB_NOTS.zip Download!]
|-
| rowspan="2" | PHP 5.3.x (vc6) || Yes || 0.82 + 20090904 patches (unconfirmed) || [http://download.moodle.org/download.php/dblib/php53_vc6/DBLIB_TS.zip Download!]
|-
| No || 0.82 + 20090904 patches (unconfirmed) || [http://download.moodle.org/download.php/dblib/php53_vc6/DBLIB_NOTS.zip Download!]
|-
| rowspan="2" | PHP 5.3.x (vc9) || Yes || 0.82 + 20090904 patches || [http://download.moodle.org/download.php/dblib/php53_vc9/DBLIB_TS.zip Download!]
|-
| No || 0.82 + 20090904 patches || [http://download.moodle.org/download.php/dblib/php53_vc9/DBLIB_NOTS.zip Download!]
|-
| rowspan="2" | PHP 5.4.x (vc9) || Yes || 0.82 + 20110906 patches || [http://download.moodle.org/download.php/dblib/php54_vc9/DBLIB_TS.zip Download!] Mirrors: [http://inethub.olvi.net.ua/ftp/pub/soft/programming/php/ms%20sql%20driver%20for%20%20php%205.4.10/dblib_ts.zip 1] [ftp://inethub.olvi.net.ua/pub/soft/programming/php/ms%20sql%20driver%20for%20%20php%205.4.10/DBLIB_TS.zip 2 (ftp)] [http://www.sendspace.com/file/vtger3 3]
|-
| No || 0.82 + 20110906 patches || [http://download.moodle.org/download.php/dblib/php54_vc9/DBLIB_NOTS.zip Download!] Mirrors: [http://inethub.olvi.net.ua/ftp/pub/soft/programming/php/ms%20sql%20driver%20for%20%20php%205.4.10/dblib_nts.zip 1] [ftp://inethub.olvi.net.ua/pub/soft/programming/php/ms%20sql%20driver%20for%20%20php%205.4.10/DBLIB_NTS.zip 2 (ftp)] [http://www.sendspace.com/file/nkg2j4 3]
|-
| rowspan="2" | PHP 5.4.x (vc9) || Yes || 0.91.102 || [http://download.moodle.org/download.php/dblib/php54_vc9_091102/DBLIB_TS.zip Download!]
|-
| No || 0.91.102 || [http://download.moodle.org/download.php/dblib/php54_vc9_091102/DBLIB_NOTS.zip Download!]
|-
| rowspan="2" | PHP 5.5.x (vc11-x86) || Yes || 0.91.89 || [http://download.moodle.org/download.php/dblib/php55_vc11_x86/DBLIB_TS.zip Download!]
|-
| No || 0.91.89 || [http://download.moodle.org/download.php/dblib/php55_vc11_x86/DBLIB_NOTS.zip Download!]
|-
| rowspan="2" | PHP 5.5.x (vc11-x64) || Yes || 0.91.93 || [http://download.moodle.org/download.php/dblib/php55_vc11_x64/DBLIB_TS.zip Download!]
|-
| No || 0.91.93 || [http://download.moodle.org/download.php/dblib/php55_vc11_x64/DBLIB_NOTS.zip Download!]
|-
| PHP 5.6.x (vc11-unkown architecture) || Both || 0.95 || You can find some (unverified/untested) drivers in [https://moodle.org/mod/forum/discuss.php?d=232844#p1297504 this forum post], courtesy of Josh Urbain.
|-
| colspan="4" | Thanks to [http://remote-learner.net/ Remote-Learner]] (Moodle [http://moodle.com/partners/ Partner]) and specially to Bryan Williams, donating one Visual C++ 6.0 Pro license to Moodle. Thanks to Trevor Johnson and his builds of the dblib extensions. Thanks to Daniele, Doug, Luis, Sean and many others by their collaboration in MDL-14725. Thanks to Frediano Ziglio and James K. Lowden from [http://freetds.org freetds.org] by their support. Thanks to [[User:Alastair Hole|Alastair Hole]] and Matt Rusiniak for providing the PHP 5.3 builds of the libraries. Thanks to Enyby by providing the PHP 5.4 builds of the libraries. Thanks to David Aylmer and Matt Rusiniak for providing the PHP 5.5 builds of the libraries. Thanks!
|}

(alternatively here you can find some [[Development:Compiling FreeTDS under Windows|instructions to build those freetds extensions under win32]] yourself)

2. FreeTDS requires the .NET Framework v1.1 to be installed. You can [http://www.microsoft.com/downloads/details.aspx?FamilyID=262d25e3-f589-4842-8157-034d1e7cf3a3&DisplayLang=en download it from the Microsoft website] along with its [http://www.microsoft.com/downloads/details.aspx?FamilyID=a8f5654f-088e-40b2-bbdb-a83353618b38&DisplayLang=en service pack]. Alternatively, if you do not wish to install this framework, you can [http://kromann.info/ms-libs/msvcr71.dll download the required DLL] from Frank's site, and save it into your /PHP root directory.

3. Edit your /PHP/php.ini file and add this line:

extension=php_dblib.dll

Make sure that any lines referring to the php_mssql.dll extension are DISABLED (commented out).

4. When the PHP engine loads the FreeTDS extension it needs to be passed certain infiormation in order to be able to connect to your Moodle database. To retrieve this information FreeTDS looks for a file called '''freetds.conf''' in the root folder of the server that PHP installed on (e.g. C:\).

'''freetds.conf''' should have the following structure:

[global]
host = xxx.xxx.xxx.xxx (host name or ip of the MSSQL server)
port = 1433
client charset = UTF-8
tds version = 8.0
text size = 20971520

If you want to connect to a particular [http://msdn.microsoft.com/en-us/library/aa174516(SQL.80).aspx instance] of MSSQL you should specify the instance name:

[global]
host = xxx.xxx.xxx.xxx (host name or ip of the MSSQL server)
instance = xxx (instance name, e.g. INST2)
port = 1433
client charset = UTF-8
tds version = 8.0
text size = 20971520

'''Notes:'''
*You can configure FreeTDS to look for the freetds.conf file in any directory that you want - you don't have to use C:\. To do this create a SYSTEM environment variable called '''FREETDS''' and point it to the directory where you have installed the freetds.conf file. If you do not set this environment variable FreeTDS will look for the freetds.conf file in the C:\ folder, which is the default. One possible benefit of setting the FREETDS environment variable and using a different installation directory for freetds.conf is that C:\ is very predictable to a hacker that knows anything about FreeTDS and that is the first place that he would look if he wanted to compromise your system. So, using a different installation directory would just make your system stronger. See the FreeTDS [http://www.freetds.org/userguide/envvar.htm Setting the environment variables] documentation for more information about this FREETDS environment variable.

*Alternatively, you can [[Development:Compiling FreeTDS under Windows|recompile]] the FreeTDS extension yourself and change the default location to your preferred location at compile time. Then it is not necessary to create any environment variable. You must just ensure that freetds.conf is in the same folder that you specify when you compile php_dblib.dll.

*MSSQL is usually installed with port 1433 as the default. However, if the port was changed on your server when you installed MSSQL then you need to specify the correct port number.

5. Your Moodle '''config.php''' should include lines like these:

<code php>
$CFG->dbtype = 'mssql'; // Required
$CFG->dbhost = 'localhost'; // assuming MS SQL is on the same server, otherwise use an IP
$CFG->dbname = 'moodle'; // or whatever you called the database you created
$CFG->dbuser = 'yourusername'; // I usually use the 'sa' account (dbowner perms are enough)
$CFG->dbpass = 'yourpassword';
$CFG->dbpersist = false;
$CFG->prefix = 'mdl_'; //Prefix, you can change it, but NEVER leave it blank.
</code>

If you don't have a config.php file yet, it can be generated as normal from the Moodle installer. Alternatively you can use the config-dist.php file that comes with the Moodle package to create your own config.php file.

6. Restart or start your web server. If Moodle still cannot communicate with the database server, please turn display_startup_errors to "On" in your /PHP/php.ini file, then restart the web server and check for any errors that may indicate incorrect DLL versions or missing dependencies. These error reports, turned off by default in PHP, can be vital in locating a problem with new extension installations.

7. Database conection test, try this PHP script, just put in a text file called test.php change ('localhost', 'db_user', 'db_password') to suite your setup, and load from local host (http://localhost/test.php)...

<code php>
<?php
$link = mssql_connect('localhost', 'db_user', 'db_password');
if(!$link) {
echo'Could not connect';
die('Could not connect: ' . mssql_error());
}
echo'Successful connection';
mssql_close($link);
?>
</code>

8. Install Moodle as usual. Good luck!

=== Troubleshooting ===
If you encounter some problems you can try:
*check that you have DotNet framework 1.1 installed (later version are installed on Vista, but you could need this specific one) 
*enable TCP/IP for MSSQL: SQL Server 2005 Network Configuration -> Protocols for MSSQLSERVER -> TCP/IP (Enable) -> Properties -> Ip Addresses -> 127.0.0.1 (Active+Enable) 
*make sure the SQL Server Browser service is running SQL Server 2005 Network Configuration -> SQL Server Services 
*if you are using SQL Server 2005 and you have the error ''4004: Unicode data in a Unicode-only collation or ntext data cannot be sent to clients using DB-Library (such as ISQL) or ODBC version 3.7 or earlier'', try the ODBTP method (next chapter). The SQL Server complaining that it doesn't support pure Unicode via TDS or older versions of ODBC. Microsoft has deprecated DB-Library a long ago, in favor of ODBC, OLE DB, or SQL Native Client. Many new features of SQL 2005 aren't accessible via DB-Library so if you need them, you could have to switch away from tools based on TDS and DB-Library :(

== FreeTDS on Linux (on Ubuntu by compiling an mssql.so extension) ==
This is a good read to [http://www.robert-gonzalez.com/2009/02/18/building-the-php-ms-sql-server-extension-from-source-on-ubuntu-810/ building a FreeTDS based mssql extension for apache on Ubuntu]. Do note that [http://www.freetds.org/news.html freeTDS] 0.91 was recently released, you can find latest versions [http://freetds.sourceforge.net/ here].

Note: the freetds.conf file you use should have "text size = 20971520" as mentioned in the FreeTDS on Windows section otherwise you might see sessions logging out or worse apache segmentation faults. Also see [[FreeTDS]].

Note2: Please note that updating php tends to remove the freetds configurations. You might need to reconfigure freetds after an upgrade

== Using FreeTDS on Debian Lenny ==
I found the following solution using:
* PHP Version 5.2.6-1+lenny9
* Microsoft SQL Server Enterprise Edition, version: 9.00.4053.00
<pre>apt-get install libsybdb5 freetds-common php5-sybase
/etc/init.d/apache2 restart</pre>
At the end of the process, if all goes fine, you will find in the mssql section of phpinfo();

{| class="nicetable"
|-
! MSSQL Support
! enabled
|-
| Library version
| FreeTDS
|}

Once FreeTDS is correctly installed, don not forget to set it up following explanations in https://docs.moodle.org/en/FreeTDS

== See also ==
* [[Errors FAQ]]
* Using Moodle [http://moodle.org/mod/forum/view.php?id=28 Installation problems forum]

[[Category:XMLDB]]
[[Category:DB]]
[[Category:SQL databases]]

AMOS

2016-02-10T22:12:26Z

Stronk7: Redirected page to dev:AMOS

#REDIRECT [[dev:AMOS]]

AMOS

2016-02-10T21:30:09Z

Stronk7:

#REDIRECT [[dev:AMOS manual]]

AMOS

2016-02-10T21:28:28Z

Stronk7:

#redirect [[dev:AMOS manual]]