MoodleDocs - User contributions [en]

Transitioning to HTTPS

2017-04-17T15:04:40Z

Poltawski: Adding a highly useful https 'why' article

{{Security}}
There are [https://developers.google.com/web/fundamentals/security/encrypt-in-transit/why-https numerous benefits] to running your moodle site using HTTPS. This increases the level of security especially involving sessions and passwords.

== Steps ==
=== Before you start ===
Check all the content you use supports https. You will not be able to embed HTTP content over HTTPS. If some content is only available over HTTP, you can convert it from a direct embedding to a link.

Make sure you have a staging environment. You will want to set up HTTPS the first time on a staging environment rather than updating your live site. It will take some time to convert to https and you will need to update content (see below).

=== Setting up an SSL certificate ===
The first thing you will need to do is acquire an SSL certificate. You can create these yourself, but this is only helpful for development purposes. Instead you will want to get your SSL certificate from a certificate authority, so that the certificate will be publicly verified.

The cost of certificates has been somewhat prohibitive, they come at various costs from a few dollars to hundreds of dollars per year. For the budget constrained, the "price is right" with a new initiative brought to us by the Internet Security Research Group (ISRG). Free domain-validated certificates can be acquired from [https://letsencrypt.org Let's Encrypt]. Let's Encrypt also tries to make the process of installing and managing certificates as painless as possible and there are numerous methods and clients available.

=== Setting up your server ===
Then you will need enable SSL on your web server to add your certificate. This process will vary depending on your web server of choice.

If you are using a proxy or load balancer, depending on your setup you will most likely want to set up the SSL certificate on your proxy server

=== Setting up your moodle ===

On a basic moodle site, it will be simple to set up https. Simply edit config.php and change http:// to https:// in $CFG->wwwroot.

However if you are using a proxy or load balancer, depending on your setup you may need to set $CFG->sslproxy to 1, and not use SSL on the moodle server. Then the load balancer or proxy server can communicate directly to your moodle site, but serve to the clients over SSL.

=== Redirecting the HTTP address to the new HTTPS address ===

You may want to add a redirection so that users who have the current http:// address to your site will be redirected automatically to the https:// address instead of getting a page with a message such as "For security reasons only https connections are allowed, sorry."

There are several ways to do redirections, depending on your web server, hosting, and how you prefer to do this. A common solution on Apache web servers is to create an .htaccess file with a rewrite rule such as:

<code>
RewriteEngine On
RewriteCond %{SERVER_PORT} 80
RewriteRule ^(.*)$ https://www.yourmoodle.com/$1 [R,L]
</code>
or in general
<code>
RewriteEngine On
RewriteCond %{SERVER_PORT} 80
RewriteRule ^(.*)$ {SERVER_NAME}/$1 [R,L]
</code>

Be sure to look up current ways to do this for your web server and host. One clear explanation for this is [https://www.ssl.com/how-to/force-https-connections-in-an-apache-server-environment/ here].

=== Updating content ===
You will need to change all embeded content from being requested over http. Links do not matter. But you will need to update images and iframes, scorm modules, and LTI external tools. You can modify external tools to open in a new window instead of in an iframe and they will work fine.

There is plans to work on a new tool to aid in this process. See MDL-46269 on the tracker.

= See also =

[https://developers.google.com/web/fundamentals/security/encrypt-in-transit/why-https Why HTTPS Matters - Google Web Fundamentals]

Upgrading

2016-12-02T12:00:13Z

Poltawski: MDL-48766 Geoip lookups using new maxmind database

{{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]]''.

Moodle 3.2 has raised the minimum required PHP version to 5.6.5.

Note: You can only upgrade to Moodle {{Version}} from Moodle 2.7 or later. If upgrading from earlier versions, you must [https://docs.moodle.org/27/en/Upgrading_to_Moodle_2.7 upgrade to 2.7] 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}}==

''Please add items here...'' See the [https://tracker.moodle.org/issues/?jql=labels%20%3D%20upgrade_notes%20and%20fixVersion%3D3.2 list of upgrade_notes-labelled issues].

===Custom roles requiring site administration access===

Any custom roles which require access to any part of site administration that do not use the manager archetype will need to be allowed the new capability, [[Capabilities/moodle/site:configview|moodle/site:configview]].

===Removed plugins===

If you use any of these plugins you need to download them during upgrade:

[https://github.com/moodlehq/moodle-auth_radius RADIUS] authentication plugin is using the mcrypt PHP functions which are deprecated as of PHP 7.1. Thus the plugin has been removed from the standard Moodle 3.2 package.

The [https://github.com/moodlehq/moodle-repository_alfresco Alfresco] repository plugin does not work with Alfresco 5.0.c or later and so has been removed from the standard Moodle 3.2 package.

Themes [https://moodle.org/plugins/theme_base Base] and [https://moodle.org/plugins/theme_canvas Canvas] have been deprecated and also removed from the standard Moodle 3.2 package. These themes can not be used by themselves but they may be used as parent themes.

===Outgoing mail setup===

Make sure to visit Site administration > Server > Email > Outgoing mail configuration. There is no longer setting "Always send from no-reply address", instead there is a setting "Allowed email domains". If you want to send emails from users real addresses you need to add domains allowed by your mail server to this list. Sending email from email addresses not matching sender domain will be detected by clients and such emails could be classified as "Spam". '''Moodle will no longer use support email as Return-Path.'''

===Recommendations on changing settings===

Some administrative settings and roles have changed their defaults in Moodle 3.2. These changes will not be automatically applied to the upgraded sites, however we recommend you to change them manually to improve security, user experience and navigation:

* Site administration > Appearance > Navigation : Show my course categories (navshowmycoursecategories). Set this to off if you use theme with flat navigation like Boost.
* Site administration > Grades > General settings : Navigation method (grade_navmethod). New default value - "Tabs". This improves navigation especially in Boost theme where "Administration" block is not available.
* Site administration > Appearance > Navigation : Link admin categories (linkadmincategories). New default value - "Yes". This improves navigation especially in Boost theme where "Administration" block is not available.
* Site administration > Security > HTTP security : cURL blocked hosts list (curlsecurityblockedhosts) and cURL allowed ports list (curlsecurityallowedport). These are two new settings improving security of cURL requests (used in blogs, URL repository, etc.). We
recommend to blacklist localhost and its aliases and allow only 80 port.
* Site administration > Courses > Course default settings : Default value for "Format" (moodlecourse/format) was changed from Weeks to Topics. Default value for "Number of sections" (moodlecourse/numsections) was changed from 10 to 4.

===Asynchronous activity deletion with Recycle bin===

Recycle bin that was added in Moodle 3.1 and automatically enabled has been found to cause slowness during activity deletion. Since Moodle 3.2 enabling recycle bin automatically means that activity deletion will happen asynchronously in the background. You must ensure that cron runs regularly, preferably every minute. Running cron every minute will '''not''' slow down the site because each task will still run only when scheduled.

===Media players===

New "Media players" plugin type was introduced in Moodle 3.2. Previously media players may have been overridden by themes. This will no longer work, instead you need to create [https://docs.moodle.org/dev/Media_players media player plugins]. We have also added and automatically enabled Video.JS as the default video and audio player. If you had filters with media players installed they may no longer be needed in Moodle 3.2.

Media players [https://github.com/moodlehq/moodle-media_flowplayerflash Flowplayer], [https://github.com/moodlehq/moodle-media_wmp Windows media player], [https://github.com/moodlehq/moodle-media_realplayer RealPlayer] and [https://github.com/moodlehq/moodle-media_quicktime Quicktime] were present in Moodle 3.1 but removed in 3.2. If they are needed they should be installed in media/player directory. Please note that Video.JS has built-in Flash player and you should no longer need Flowplayer. Other three players were removed because these formats are extremely rare in the modern world and most browsers don't support them anyway.

See the [[dev:Moodle {{Version}} release notes|Moodle {{Version}} release notes]] for the full list of changes in Moodle {{Version}}.

===Customised MathJax URL===

If you customised the mathjax CDN url note that filter_mathjaxloader/httpurl has been removed and only filter_mathjaxloader/httpsurl is used.

=== IP address lookups ===

Moodle now supports looking up IPv6 addresses using the [http://dev.maxmind.com/geoip/geoip2/geolite2/ GeoLite2] database from [http://www.maxmind.com Maxmind]. This replaces the existing GeoLite legacy database used in previous versions and the new GeoIP2 database will need to be installed to use this functionality.

=== Moodle 2.9, 3.0 and 3.1 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/29/en/Upgrading Upgrading to Moodle 2.9]
* [https://docs.moodle.org/30/en/Upgrading Upgrading to Moodle 3.0]
* [https://docs.moodle.org/31/en/Upgrading Upgrading to Moodle 3.1]

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

2016-12-02T11:49:47Z

Poltawski: /* Customised MathJax URL */

{{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]]''.

Moodle 3.2 has raised the minimum required PHP version to 5.6.5.

Note: You can only upgrade to Moodle {{Version}} from Moodle 2.7 or later. If upgrading from earlier versions, you must [https://docs.moodle.org/27/en/Upgrading_to_Moodle_2.7 upgrade to 2.7] 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}}==

''Please add items here...'' See the [https://tracker.moodle.org/issues/?jql=labels%20%3D%20upgrade_notes%20and%20fixVersion%3D3.2 list of upgrade_notes-labelled issues].

===Custom roles requiring site administration access===

Any custom roles which require access to any part of site administration that do not use the manager archetype will need to be allowed the new capability, [[Capabilities/moodle/site:configview|moodle/site:configview]].

===Removed plugins===

If you use any of these plugins you need to download them during upgrade:

[https://github.com/moodlehq/moodle-auth_radius RADIUS] authentication plugin is using the mcrypt PHP functions which are deprecated as of PHP 7.1. Thus the plugin has been removed from the standard Moodle 3.2 package.

The [https://github.com/moodlehq/moodle-repository_alfresco Alfresco] repository plugin does not work with Alfresco 5.0.c or later and so has been removed from the standard Moodle 3.2 package.

Themes [https://moodle.org/plugins/theme_base Base] and [https://moodle.org/plugins/theme_canvas Canvas] have been deprecated and also removed from the standard Moodle 3.2 package. These themes can not be used by themselves but they may be used as parent themes.

===Outgoing mail setup===

Make sure to visit Site administration > Server > Email > Outgoing mail configuration. There is no longer setting "Always send from no-reply address", instead there is a setting "Allowed email domains". If you want to send emails from users real addresses you need to add domains allowed by your mail server to this list. Sending email from email addresses not matching sender domain will be detected by clients and such emails could be classified as "Spam". '''Moodle will no longer use support email as Return-Path.'''

===Recommendations on changing settings===

Some administrative settings and roles have changed their defaults in Moodle 3.2. These changes will not be automatically applied to the upgraded sites, however we recommend you to change them manually to improve security, user experience and navigation:

* Site administration > Appearance > Navigation : Show my course categories (navshowmycoursecategories). Set this to off if you use theme with flat navigation like Boost.
* Site administration > Grades > General settings : Navigation method (grade_navmethod). New default value - "Tabs". This improves navigation especially in Boost theme where "Administration" block is not available.
* Site administration > Appearance > Navigation : Link admin categories (linkadmincategories). New default value - "Yes". This improves navigation especially in Boost theme where "Administration" block is not available.
* Site administration > Security > HTTP security : cURL blocked hosts list (curlsecurityblockedhosts) and cURL allowed ports list (curlsecurityallowedport). These are two new settings improving security of cURL requests (used in blogs, URL repository, etc.). We
recommend to blacklist localhost and its aliases and allow only 80 port.
* Site administration > Courses > Course default settings : Default value for "Format" (moodlecourse/format) was changed from Weeks to Topics. Default value for "Number of sections" (moodlecourse/numsections) was changed from 10 to 4.

===Asynchronous activity deletion with Recycle bin===

Recycle bin that was added in Moodle 3.1 and automatically enabled has been found to cause slowness during activity deletion. Since Moodle 3.2 enabling recycle bin automatically means that activity deletion will happen asynchronously in the background. You must ensure that cron runs regularly, preferably every minute. Running cron every minute will '''not''' slow down the site because each task will still run only when scheduled.

===Media players===

New "Media players" plugin type was introduced in Moodle 3.2. Previously media players may have been overridden by themes. This will no longer work, instead you need to create [https://docs.moodle.org/dev/Media_players media player plugins]. We have also added and automatically enabled Video.JS as the default video and audio player. If you had filters with media players installed they may no longer be needed in Moodle 3.2.

Media players [https://github.com/moodlehq/moodle-media_flowplayerflash Flowplayer], [https://github.com/moodlehq/moodle-media_wmp Windows media player], [https://github.com/moodlehq/moodle-media_realplayer RealPlayer] and [https://github.com/moodlehq/moodle-media_quicktime Quicktime] were present in Moodle 3.1 but removed in 3.2. If they are needed they should be installed in media/player directory. Please note that Video.JS has built-in Flash player and you should no longer need Flowplayer. Other three players were removed because these formats are extremely rare in the modern world and most browsers don't support them anyway.

See the [[dev:Moodle {{Version}} release notes|Moodle {{Version}} release notes]] for the full list of changes in Moodle {{Version}}.

===Customised MathJax URL===

If you customised the mathjax CDN url note that filter_mathjaxloader/httpurl has been removed and only filter_mathjaxloader/httpsurl is used.

=== Moodle 2.9, 3.0 and 3.1 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/29/en/Upgrading Upgrading to Moodle 2.9]
* [https://docs.moodle.org/30/en/Upgrading Upgrading to Moodle 3.0]
* [https://docs.moodle.org/31/en/Upgrading Upgrading to Moodle 3.1]

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

2016-12-02T11:49:17Z

Poltawski: Mathjax - MDL-53572

{{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]]''.

Moodle 3.2 has raised the minimum required PHP version to 5.6.5.

Note: You can only upgrade to Moodle {{Version}} from Moodle 2.7 or later. If upgrading from earlier versions, you must [https://docs.moodle.org/27/en/Upgrading_to_Moodle_2.7 upgrade to 2.7] 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}}==

''Please add items here...'' See the [https://tracker.moodle.org/issues/?jql=labels%20%3D%20upgrade_notes%20and%20fixVersion%3D3.2 list of upgrade_notes-labelled issues].

===Custom roles requiring site administration access===

Any custom roles which require access to any part of site administration that do not use the manager archetype will need to be allowed the new capability, [[Capabilities/moodle/site:configview|moodle/site:configview]].

===Removed plugins===

If you use any of these plugins you need to download them during upgrade:

[https://github.com/moodlehq/moodle-auth_radius RADIUS] authentication plugin is using the mcrypt PHP functions which are deprecated as of PHP 7.1. Thus the plugin has been removed from the standard Moodle 3.2 package.

The [https://github.com/moodlehq/moodle-repository_alfresco Alfresco] repository plugin does not work with Alfresco 5.0.c or later and so has been removed from the standard Moodle 3.2 package.

Themes [https://moodle.org/plugins/theme_base Base] and [https://moodle.org/plugins/theme_canvas Canvas] have been deprecated and also removed from the standard Moodle 3.2 package. These themes can not be used by themselves but they may be used as parent themes.

===Outgoing mail setup===

Make sure to visit Site administration > Server > Email > Outgoing mail configuration. There is no longer setting "Always send from no-reply address", instead there is a setting "Allowed email domains". If you want to send emails from users real addresses you need to add domains allowed by your mail server to this list. Sending email from email addresses not matching sender domain will be detected by clients and such emails could be classified as "Spam". '''Moodle will no longer use support email as Return-Path.'''

===Recommendations on changing settings===

Some administrative settings and roles have changed their defaults in Moodle 3.2. These changes will not be automatically applied to the upgraded sites, however we recommend you to change them manually to improve security, user experience and navigation:

* Site administration > Appearance > Navigation : Show my course categories (navshowmycoursecategories). Set this to off if you use theme with flat navigation like Boost.
* Site administration > Grades > General settings : Navigation method (grade_navmethod). New default value - "Tabs". This improves navigation especially in Boost theme where "Administration" block is not available.
* Site administration > Appearance > Navigation : Link admin categories (linkadmincategories). New default value - "Yes". This improves navigation especially in Boost theme where "Administration" block is not available.
* Site administration > Security > HTTP security : cURL blocked hosts list (curlsecurityblockedhosts) and cURL allowed ports list (curlsecurityallowedport). These are two new settings improving security of cURL requests (used in blogs, URL repository, etc.). We
recommend to blacklist localhost and its aliases and allow only 80 port.
* Site administration > Courses > Course default settings : Default value for "Format" (moodlecourse/format) was changed from Weeks to Topics. Default value for "Number of sections" (moodlecourse/numsections) was changed from 10 to 4.

===Asynchronous activity deletion with Recycle bin===

Recycle bin that was added in Moodle 3.1 and automatically enabled has been found to cause slowness during activity deletion. Since Moodle 3.2 enabling recycle bin automatically means that activity deletion will happen asynchronously in the background. You must ensure that cron runs regularly, preferably every minute. Running cron every minute will '''not''' slow down the site because each task will still run only when scheduled.

===Media players===

New "Media players" plugin type was introduced in Moodle 3.2. Previously media players may have been overridden by themes. This will no longer work, instead you need to create [https://docs.moodle.org/dev/Media_players media player plugins]. We have also added and automatically enabled Video.JS as the default video and audio player. If you had filters with media players installed they may no longer be needed in Moodle 3.2.

Media players [https://github.com/moodlehq/moodle-media_flowplayerflash Flowplayer], [https://github.com/moodlehq/moodle-media_wmp Windows media player], [https://github.com/moodlehq/moodle-media_realplayer RealPlayer] and [https://github.com/moodlehq/moodle-media_quicktime Quicktime] were present in Moodle 3.1 but removed in 3.2. If they are needed they should be installed in media/player directory. Please note that Video.JS has built-in Flash player and you should no longer need Flowplayer. Other three players were removed because these formats are extremely rare in the modern world and most browsers don't support them anyway.

See the [[dev:Moodle {{Version}} release notes|Moodle {{Version}} release notes]] for the full list of changes in Moodle {{Version}}.

===Customised MathJax URL===

If you customised the mathjax CDN url note that filter_mathjaxloader/httpurl has been removed and only filter_mathjaxloader/httpsurl is used for all pages

=== Moodle 2.9, 3.0 and 3.1 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/29/en/Upgrading Upgrading to Moodle 2.9]
* [https://docs.moodle.org/30/en/Upgrading Upgrading to Moodle 3.0]
* [https://docs.moodle.org/31/en/Upgrading Upgrading to Moodle 3.1]

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

Global search

2016-07-08T09:36:17Z

Poltawski: Switch to cli script rather than scheduled tak

{{More features}}
{{New features}}
==What is Global search?==
*Global search lets you search everywhere on the Moodle site that you have access to. A student can search their courses for particular lecture notes, for example, or a teacher could search for subject-related activities.
*The feature needs to be enabled by the administrator and a search box is then available next to the user menu.

[[File:NFGlobalsearchbox.png|thumb|center|480px|Searching the site (when global search is enabled)]]

*A [[Global search block]] may also be added to course pages.

==What can I search for?==
You can search for your courses, activities information and some activities contents like forum posts, book chapters, glossary entries or collaborative wikis pages. We will add more contents in future Moodle versions. Developers interested in adding plugin's contents to global search may be interested in looking at the [https://docs.moodle.org/dev/Search_API Search API].

==How does it work?==
*Click the search icon by the user menu and type a search term into the box that appears, or type into the box in the [[Global search block]] if enabled.
*On the next screen, you can simply click the search button to search everywhere, or expand the Filter to search in specific areas:

[[File:NFFilteringGlobalSearch2.png|thumb|center|600px|Filtering the search]]

*You will then see results displayed from all areas of Moodle you have access to:

[[File:31GSResults2a.png|thumb|center|600px|Search results]]

===Solr search query features===

You can improve your search using any of the following search query features:

* Specifying the field to be searched by prefixing the search query with 'title:', 'content:', 'name:', or 'intro:' e.g.'title:news' returns results with the word 'news' in the title
* Boolean operators ('AND', 'OR', 'NOT') to combine or exclude keywords
* Wildcard characters ('*' or '?' ) to represent characters in the search query
* Proximity searches ('~') e.g. mood~2 returns "moodle" (2 letters away from "mood"), Moodle Australia~3 returns results containing "Moodle HQ in Perth, Australia" (the queried terms were within 3 words of each other)
* Boosting terms ('^') to boost certain words or phrases e.g. "Perth Australia"^5 "Australia" will return results with the phrase "Perth Australia" as more relevant.

Note: The above features are only available when using the Solr search engine.

==How is it set up?==

{{Note|Global search needs a search engine. Instructions for the installing the PHP Solr extension and a Solr server are below. See the [https://docs.moodle.org/dev/Search_engines Developer docs on Search engine plugins] if you wish to write your own. It's recommended you set everything up first, index the site contents ''and only then'' enable Global search.}}

===Setting up Solr===

====General Setup====

# Set the feature up in ''Site administration > Plugins > Search > Manage global search'' by selecting Solr as the search engine and ticking search area checkboxes as required
# In ''Site administration > Plugins > Search > Solr'', set '''Host name''' to localhost, '''Port''' to 8983 and '''Index name''' to 'moodle' (the name of the index in Solr)
# If you are using Solr with SSL encryption, you will need to configure Moodle as such. This is important if solr is not installed in the web server server.
## You will need a separate key file and cacert file, both in pem format, located on your server Moodle, and readable by the PHP process.
## Go to ''Site administration > Plugins > Search > Solr''
## Set '''Secure mode''' to Yes
## '''SSL certificate''' to /path/to/certs/solr-ssl.cacert.pem
## '''SSL key''' to /path/to/certs/solr-ssl.key.pem
## '''SSL key Password''' to The password used to lock the SSL Key
## '''SSL CA certificates name''' to /path/to/certs/solr-ssl.cacert.pem
# Index your site's data going to ''Site administration > Reports > Global search info'' or from the CLI running '''php search/cli/indexer.php -f''' script, being the CLI script the recommended option for big sites.
# Enable Global search in ''Site administration > Advanced features''

====File Indexing====

Solr has the ability to index the contents of files, such as File resources and attachments to Forum posts. This uses the [https://tika.apache.org/ Tika] engine which comes bundled with Solr. To enable this feature:
# In ''Site administration > Plugins > Search > Solr'' enable the checkbox '''Enable file indexing'''
# Set '''Maximum file size to index (kB)''' to some value - the default is '''2097152''' (2GB)
#* Files larger than this limit will not be sent for Solr for indexing, but the file name will still be indexed.

===How to install Solr===

You need PHP Solr extension installed. You can download the official latest versions from [http://pecl.php.net/package/solr](http://pecl.php.net/package/solr) The minimum required version is PECL Solr 2.1 for PHP 5 branch and PECL Solr 2.4 for PHP 7 branch.

Basic installation steps (using apache web server):

==== Linux (Debian/Ubuntu) ====

sudo apt-get install libpcre3-dev libxml2-dev libcurl4-openssl-dev
sudo apt-get install php5-dev
sudo apt-get install php-pear
sudo pecl install solr
sudo sh -c "echo 'extension=solr.so' > /etc/php5/apache2/conf.d/solr.ini"
sudo sh -c "echo 'extension=solr.so' > /etc/php5/cli/conf.d/solr.ini"
sudo service apache2 restart

==== Linux (Redhat/Centos7) ====

===== Using built in php5 packages =====
yum install php-pecl-solr2
service httpd restart

===== Using 3rd party php7 packages (webtactic) =====
yum install libxml2-devel pcre-devel libcurl-devel php70w-devel php70w-pear
pecl install solr
echo "extension=solr.so" > /etc/php.d/solr.ini
service httpd restart

==== OSX using macports ====

sudo port install apache-solr4
sudo port install php54-solr

==== OSX using homebrew ====

brew install homebrew/php/php56-solr

==== Windows ====

Install the pecl package as usual. (This has not yet been tested.)

==== The Solr server ====

Moodle 3.1 supports Solr server from 4.0 onwards, although you can only use the Solr schema setup script that we provide with Moodle from Solr 5. The latest Solr 5 available version is the recommended one; the same will apply to Solr 6 once it is released.

Note that for medium/large sites you may need to increase maxBooleanClauses setting. In [https://tracker.moodle.org/browse/MDL-54992 MDL-54992] we are working on an alternative way to query the server.

The following example snippet (feel free to copy & paste into a .sh script with execution permissions) will download Solr 5.4.1 (replace it with latest 5.x) in the current directory, start the solr server and create an index in it named '''moodle''' to add moodle data to it.

#!/bin/bash
set -e
SOLRVERSION=5.4.1
SOLRNAME=solr-$SOLRVERSION
SOLRTAR=$SOLRNAME'.tgz'
INDEXNAME=moodle
if [ -d $SOLRNAME ]; then
echo "Error: Directory $SOLRNAME already exists, remove it before starting the setup again."
exit 1
fi
if [ ! -f $SOLRTAR ]; then
wget http://www-us.apache.org/dist/lucene/solr/$SOLRVERSION/$SOLRTAR
fi
tar -xvzf $SOLRTAR
cd $SOLRNAME
bin/solr start
bin/solr create -c $INDEXNAME
# After setting it up and creating the index use:
# - "/yourdirectory/solrdir/bin/solr start" from CLI to start the server
# - "/yourdirectory/solrdir/bin/solr stop" from CLI to stop the server.

=====Solr 5/6 schema setup=====

Moodle will use Solr's managed schema interface to install the required fields. You will be directed on what to do from the Manage global search page.

For very large or busy sites, it is recommended that you manually remove the '''_text_''' field, and associated copy directive from, the default Solr schema. This field is not used by Moodle, and will significantly slow indexing, and increase the size of the resulting Solr core.

=====Solr 4 schema setup=====

You cannot use the schema setup script when using a Solr 4 server. If you really want to use the Solr 4x branch, here are the field types descriptions:

Extracted from search/classes/document.php

{| class="nicetable"
|-
! Field name
! Field type
! Stored
! Indexed
! Query field
|-
| id
| org.apache.solr.schema.StrField
| true
| false
| false
|-
| itemid
| org.apache.solr.schema.TrieIntField
| true
| true
| false
|-
| title
| org.apache.solr.schema.TextField
| true
| true
| true
|-
| content
| org.apache.solr.schema.TextField
| true
| true
| true
|-
| contextid
| org.apache.solr.schema.TrieIntField
| true
| true
| false
|-
| areaid
| org.apache.solr.schema.StrField
| true
| true
| false
|-
| type
| org.apache.solr.schema.TrieIntField
| true
| true
| false
|-
| courseid
| org.apache.solr.schema.TrieIntField
| true
| true
| false
|-
| owneruserid
| org.apache.solr.schema.TrieIntField
| true
| true
| false
|-
| modified
| org.apache.solr.schema.TrieDateField
| true
| true
| false
|-
| userid
| org.apache.solr.schema.TrieIntField
| true
| true
| false
|-
| description1
| org.apache.solr.schema.TextField
| true
| true
| true
|-
| description2
| org.apache.solr.schema.TextField
| true
| true
| true
|-
| solr_filegroupingid
| org.apache.solr.schema.StrField
| true
| true
| false
|-
| solr_fileid
| org.apache.solr.schema.StrField
| true
| true
| false
|-
| solr_filecontenthash
| org.apache.solr.schema.StrField
| true
| true
| false
|-
| solr_fileindexstatus
| org.apache.solr.schema.TrieIntField
| true
| true
| false
|-
| solr_filecontent
| org.apache.solr.schema.TextField
| false
| true
| true
|}

=====Memory and File indexing considerations=====

For large sites, and particularly if you are using the File indexing feature, it's a good idea to give Solr plenty of memory, eg aound 10-20GB. To start Solr with more than its default 512MB of RAM, use the ''-m'' option:
solr start -m 12g

See the documents for your version of Solr on how to increases memory when Solr is started automatically.

=====Too many boolean clauses error=====

Because of the way Moodle handles permissions for searches, if you have non-admin users with access to a large number of activities (>1000), they may an error similar to the following:

The query you provided could not be parsed by the search engine: org.apache.solr.search.SyntaxError: Cannot parse
...
too many boolean clauses

To correct this, you need to increase the ''maxBooleanClauses'' setting in your Solr core. The setting is located in ''corename/conf/solrconfig.xml''.

This important note is included in the config file:
** WARNING **

This option actually modifies a global Lucene property that
will affect all SolrCores. If multiple solrconfig.xml files
disagree on this property, the value at any given moment will
be based on the last SolrCore to be initialized.

This means that for consistent behavior you should update this value for all cores in the Solr server.

==See also==

* [https://moodle.org/mod/forum/discuss.php?d=334938 Global search doesn't index plugins?] forum discussion

[[es:Búsqueda global]]

error/search/engineserverstatus

2016-06-30T09:29:32Z

Poltawski: Created page with "Search Engine is not available There is a search enginge problem with your server. The Moodle administrator need to check the search engine configuration."

Search Engine is not available

There is a search enginge problem with your server. The Moodle administrator need to check the search engine configuration.

Security FAQ

2015-11-17T09:12:43Z

Poltawski: /* I have discovered Cross Site Scripting (XSS) is possible with Moodle */

{{Security}}
==How do I report a security issue?==

See [[:dev:Moodle security procedures|Moodle security procedures]] in the dev docs for details on how to report a security issue.

Previously fixed security issues are listed in the [http://moodle.org/security/ Moodle.org Security news]. If you are unsure whether a problem has been fixed or not, it's best to report it anyway.

==How can I keep my site secure?==

It's good practice to always use the latest stable release of the version you are using. It is safe to upgrade to a more recent version on the branch you are using, say from Moodle 2.X.1 to the latest version on the 2.X branch. [[Git for Administrators|Downloading via Git]] makes it very easy way to do this.

==How do I keep track of recent security issues?==

* [[Site registration | Register your Moodle site with moodle.org]], making sure to enable the option of being notified about security issues and updates. After your registration is accepted, your email address will be automatically added to our low-volume security alerts mailing list.

* Eventually, all important security issues are published to the general public via the [http://moodle.org/mod/forum/view.php?f=996 Moodle Security forum]. You can subscribe to the forum or [http://twitter.com/moodlesecurity follow moodlesecurity on Twitter].

==Who is able to view security issues in the Tracker?==

Depending upon the security level of a Tracker issue, access is restricted to developers, testers or members of the security team.

==Which versions of Moodle are supported?==

Currently supported versions are listed on [http://download.moodle.org/ download.moodle.org].

==My site was hacked. What do I do?==

See [[Hacked site recovery]].

==How can I reduce spam in Moodle?==

See [[Reducing spam in Moodle]].

==How can I increase privacy in Moodle?==

See [[Increasing privacy in Moodle]].

==How do I enable reCAPTCHA?==

To add spam protection to the [[Email-based self-registration]] new account form with a CAPTCHA element:

#Obtain a reCAPTCHA key from http://recaptcha.net by [https://admin.recaptcha.net/accounts/signup/?next= signing up for an account] (free) then entering a domain.
#Copy and paste the public and private keys provided into the ''recaptchapublickey'' and ''recaptchaprivatekey'' fields in the manage authentication common settings in ''Administration > Plugins > Authentication > [[Manage authentication]]''.
#Click the "Save changes" button at the bottom of the page.
#Follow the settings link for email-based self-registration in ''Administration > Plugins > Authentication > Manage authentication'' and enable the reCAPTCHA element.
#Click the "Save changes" button at the bottom of the page.

==How can I run the security overview report?==

To run the [[Security overview|security overview report]], go to ''Administration > Site administration > Reports > Security overview''.

== I have discovered Cross Site Scripting (XSS) is possible with Moodle ==

Some forms of rich content used by teachers to enhance their courses use the same technologies that malicious users can use for cross-site scripting attacks. If Moodle was solely concerned with security, it would not allow this. However, Moodle is also concerned with education and so a balance has to be struck between securing the system and supporting teachers with their needs.

In order to strike a balance between authoring rich educational content and securing the system, access to post XSS-capable content is controlled by capabilites flagged with the 'XSS risk' - see [[Risks]]. In general this means that admins and teachers can post XSS-capable content, but students can not - see [[XSS_trusted_users]].

Occasionally security bugs are discovered in Moodle's handling of XSS capable content and we are greatful to the community for reporting these through [https://docs.moodle.org/dev/Moodle_security_procedures responsible disclosure]. Before reporting an XSS bug to Moodle, please ensure that the user posting the XSS content does not have capabilities flagged with the XSS risk.

==See also==

* Using Moodle [http://moodle.org/mod/forum/view.php?id=7301 Security and Privacy forum]

[[Category:FAQ]]

Security FAQ

2015-11-17T09:12:25Z

Poltawski: /* I have discovered Cross Site Scripting (XSS) is possible with Moodle */

{{Security}}
==How do I report a security issue?==

See [[:dev:Moodle security procedures|Moodle security procedures]] in the dev docs for details on how to report a security issue.

Previously fixed security issues are listed in the [http://moodle.org/security/ Moodle.org Security news]. If you are unsure whether a problem has been fixed or not, it's best to report it anyway.

==How can I keep my site secure?==

It's good practice to always use the latest stable release of the version you are using. It is safe to upgrade to a more recent version on the branch you are using, say from Moodle 2.X.1 to the latest version on the 2.X branch. [[Git for Administrators|Downloading via Git]] makes it very easy way to do this.

==How do I keep track of recent security issues?==

* [[Site registration | Register your Moodle site with moodle.org]], making sure to enable the option of being notified about security issues and updates. After your registration is accepted, your email address will be automatically added to our low-volume security alerts mailing list.

* Eventually, all important security issues are published to the general public via the [http://moodle.org/mod/forum/view.php?f=996 Moodle Security forum]. You can subscribe to the forum or [http://twitter.com/moodlesecurity follow moodlesecurity on Twitter].

==Who is able to view security issues in the Tracker?==

Depending upon the security level of a Tracker issue, access is restricted to developers, testers or members of the security team.

==Which versions of Moodle are supported?==

Currently supported versions are listed on [http://download.moodle.org/ download.moodle.org].

==My site was hacked. What do I do?==

See [[Hacked site recovery]].

==How can I reduce spam in Moodle?==

See [[Reducing spam in Moodle]].

==How can I increase privacy in Moodle?==

See [[Increasing privacy in Moodle]].

==How do I enable reCAPTCHA?==

To add spam protection to the [[Email-based self-registration]] new account form with a CAPTCHA element:

#Obtain a reCAPTCHA key from http://recaptcha.net by [https://admin.recaptcha.net/accounts/signup/?next= signing up for an account] (free) then entering a domain.
#Copy and paste the public and private keys provided into the ''recaptchapublickey'' and ''recaptchaprivatekey'' fields in the manage authentication common settings in ''Administration > Plugins > Authentication > [[Manage authentication]]''.
#Click the "Save changes" button at the bottom of the page.
#Follow the settings link for email-based self-registration in ''Administration > Plugins > Authentication > Manage authentication'' and enable the reCAPTCHA element.
#Click the "Save changes" button at the bottom of the page.

==How can I run the security overview report?==

To run the [[Security overview|security overview report]], go to ''Administration > Site administration > Reports > Security overview''.

== I have discovered Cross Site Scripting (XSS) is possible with Moodle ==

Some forms of rich content used by teachers to enhance their courses use the same technologies that malicious users can use for cross-site scripting attacks. If Moodle was solely concerned with security, it would not allow this. However, Moodle is also concerned with education and so a balance has to be struck between securing the system and supporting teachers with their needs.

In order to strike a balance between authoring rich educational content and securing the system, access to post XSS-capable content is controlled by capabilites flagged with the 'XSS risk' - see [[Risks]]. In general this means that admins and teachers can post XSS-capable content, but students can not - see [[XSS_trusted_users]].

Occasionally security bugs are discovered in Moodle's handling of XSS capable content and we are greatful to the community for reporting these through [https://docs.moodle.org/dev/Moodle_security_procedures|responsible disclosure]. Before reporting an XSS bug to Moodle, please ensure that the user posting the XSS content does not have capabilities flagged with the XSS risk.

==See also==

* Using Moodle [http://moodle.org/mod/forum/view.php?id=7301 Security and Privacy forum]

[[Category:FAQ]]

Security FAQ

2015-11-17T09:00:45Z

Poltawski: FAQ about XSS

{{Security}}
==How do I report a security issue?==

See [[:dev:Moodle security procedures|Moodle security procedures]] in the dev docs for details on how to report a security issue.

Previously fixed security issues are listed in the [http://moodle.org/security/ Moodle.org Security news]. If you are unsure whether a problem has been fixed or not, it's best to report it anyway.

==How can I keep my site secure?==

It's good practice to always use the latest stable release of the version you are using. It is safe to upgrade to a more recent version on the branch you are using, say from Moodle 2.X.1 to the latest version on the 2.X branch. [[Git for Administrators|Downloading via Git]] makes it very easy way to do this.

==How do I keep track of recent security issues?==

* [[Site registration | Register your Moodle site with moodle.org]], making sure to enable the option of being notified about security issues and updates. After your registration is accepted, your email address will be automatically added to our low-volume security alerts mailing list.

* Eventually, all important security issues are published to the general public via the [http://moodle.org/mod/forum/view.php?f=996 Moodle Security forum]. You can subscribe to the forum or [http://twitter.com/moodlesecurity follow moodlesecurity on Twitter].

==Who is able to view security issues in the Tracker?==

Depending upon the security level of a Tracker issue, access is restricted to developers, testers or members of the security team.

==Which versions of Moodle are supported?==

Currently supported versions are listed on [http://download.moodle.org/ download.moodle.org].

==My site was hacked. What do I do?==

See [[Hacked site recovery]].

==How can I reduce spam in Moodle?==

See [[Reducing spam in Moodle]].

==How can I increase privacy in Moodle?==

See [[Increasing privacy in Moodle]].

==How do I enable reCAPTCHA?==

To add spam protection to the [[Email-based self-registration]] new account form with a CAPTCHA element:

#Obtain a reCAPTCHA key from http://recaptcha.net by [https://admin.recaptcha.net/accounts/signup/?next= signing up for an account] (free) then entering a domain.
#Copy and paste the public and private keys provided into the ''recaptchapublickey'' and ''recaptchaprivatekey'' fields in the manage authentication common settings in ''Administration > Plugins > Authentication > [[Manage authentication]]''.
#Click the "Save changes" button at the bottom of the page.
#Follow the settings link for email-based self-registration in ''Administration > Plugins > Authentication > Manage authentication'' and enable the reCAPTCHA element.
#Click the "Save changes" button at the bottom of the page.

==How can I run the security overview report?==

To run the [[Security overview|security overview report]], go to ''Administration > Site administration > Reports > Security overview''.

== I have discovered Cross Site Scripting (XSS) is possible with Moodle ==

Some forms of rich content used by teachers to enhance their courses use the same technologies that malicious users can use for cross-site scripting attacks. If Moodle was solely concerned with security, it would not allow this. However, Moodle is also concerned with education and so a balance has to be struck between securing the system and supporting teachers with their needs.

In order to strike a balance between authoring rich educational content and securing the system, access to post XSS-capable content is controlled by capabilites flagged with the 'XSS risk' - see [[Risks]]. In general this means that admins and teachers can post XSS-capable content, but students can not - see [[XSS_trusted_users]].

Occasionally security bugs are discovered in Moodle's handling of XSS capable content and we are greatful to the community for reporting these through [https://docs.moodle.org/dev/Moodle_security_procedures| responsible disclosure]. Before reporting an XSS bug to Moodle, please ensure that the user posting the XSS content does not have capabilities flagged with the XSS risk.

==See also==

* Using Moodle [http://moodle.org/mod/forum/view.php?id=7301 Security and Privacy forum]

[[Category:FAQ]]

Talk:Upload users

2014-10-14T14:45:45Z

Poltawski: I convinced Paul to update the page :)

==Notes from Moodle 2.1 uploaduser.php==
firstname, lastname, username, email, city, country, lang, timezone, mailformat, maildisplay, maildigest, htmleditor, ajax, autosubscribe ,institution, department , idnumber, skype , msn, aim, yahoo, icq, phone1, phone2, address, url, description, descriptionformat, password, auth, oldusername , deleted, course1, course2, course3, course4

// watch out when changing auth type or using external auth plugins!
// use oldusername when renaming users - this is the original username
// 1 means delete user
//course# not sure about these put short course name

--[[User:chris collman|chris collman]] 21:22, 22 November 2011 (WST)

==ISO Website broken link==
The [http://www.iso.org/iso/country_codes/iso_3166_code_lists/english_country_names_and_code_elements.htm english_country_names_and_code_elements.htm] link on the iso.org website is no longer valid. The [http://web.archive.org/web/20110721031148/http://www.iso.org/iso/country_codes/iso_3166_code_lists/english_country_names_and_code_elements.htm Web Archive] copy of that page indicates that the same info is now on [http://www.iso.org/iso/country_names_and_code_elements http://www.iso.org/iso/country_names_and_code_elements], so I'm updating the link.

--[[User:Luis de Vasconcelos|Luis de Vasconcelos]] 14:52, 13 July 2012 (WST)

:Thanks Luis for your help :-) --[[User:Helen Foster|Helen Foster]] 17:34, 18 July 2012 (WST)

== Role field ==

In the description of the field TYPE some id's are mentioned. Please be aware that these are not the same as you should use in the column ROLE. In ROLE you should use the ID of the roles that can be found through 'Define roles'. Can't quite figure out what TYPE is meant for.

Talk:Upload users

2014-10-14T14:04:24Z

Poltawski: dumping rather than fixing..

Upgrading

2014-07-17T10:51:41Z

Poltawski: MDLSITE-3246 Formal white now in plugins DB

{{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 2.7 in ''Administration > Site administration > Server > [[Environment]]''.

Note: You can only upgrade to Moodle 2.7 from Moodle 2.2 or later. If upgrading from earlier versions, you must [https://docs.moodle.org/22/en/Upgrading_to_Moodle_2.2 upgrade to 2.2] 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.'''

===Themes===

All standard themes present in Moodle 2.6 (and earlier), except the Clean theme, have been removed from Moodle 2.7 (see MDL-43784). Custom themes and themes from the Plugins Directory are not affected, unless they use one of the removed themes as a parent theme. If a theme that was in use has been removed, the theme will revert to the new default theme called Clean.

For sites wishing to continue using any of the removed standard themes (or themes relying on a standard theme as a parent theme), other than Clean, we recommend you use the following process.

# Download the 2.7 version of Moodle, but do not run the upgrade yet.
# Download the 2.7 version of your theme from the [https://moodle.org/plugins/browse.php?list=category&id=3 Themes section of the Moodle plugins directory] (or from the links below) into moodle/theme/.
# Proceed with the upgrade.

It is possible to copy missing themes into Moodle after the upgrade, but this should happen before users touch the system, otherwise theme-related settings may be lost.

The affected themes (with download links) are...

{|-
| Afterburner
| [https://moodle.org/plugins/view.php?plugin=theme_afterburner plugins db]
| [https://github.com/moodlehq/moodle-theme_afterburner github]
|-
| Anomaly
| [https://moodle.org/plugins/view.php?plugin=theme_anomaly plugins db]
| [https://github.com/moodlehq/moodle-theme_anomaly github]
|-
| Arialist
| [https://moodle.org/plugins/view.php?plugin=theme_arialist plugins db]
| [https://github.com/moodlehq/moodle-theme_arialist github]
|-
| Binarius
| [https://moodle.org/plugins/view.php?plugin=theme_binarius plugins db]
| [https://github.com/moodlehq/moodle-theme_binarius github]
|-
| Boxxie
| [https://moodle.org/plugins/view.php?plugin=theme_boxxie plugins db]
| [https://github.com/moodlehq/moodle-theme_boxxie github]
|-
| Brick
| [https://moodle.org/plugins/view.php?plugin=theme_brick plugins db]
| [https://github.com/moodlehq/moodle-theme_brick github]
|-
| Formal White
| [https://moodle.org/plugins/view.php?plugin=theme_formal_white plugins db]
| [https://github.com/andreabix/moodle-theme_formal_white github]
|-
| Form Factor
| [https://moodle.org/plugins/view.php?plugin=theme_formfactor plugins db]
| [https://github.com/moodlehq/moodle-theme_formfactor github]
|-
| Fusion
| [https://moodle.org/plugins/view.php?plugin=theme_fusion plugins db]
| [https://github.com/moodlehq/moodle-theme_fusion github]
|-
| Leatherbound
| [https://moodle.org/plugins/view.php?plugin=theme_leatherbound plugins db]
| [https://github.com/moodlehq/moodle-theme_leatherbound github]
|-
| Magazine
| [https://moodle.org/plugins/view.php?plugin=theme_magazine plugins db]
| [https://github.com/moodlehq/moodle-theme_magazine github]
|-
| Nimble
| [https://moodle.org/plugins/view.php?plugin=theme_nimble plugins db]
| [https://github.com/moodlehq/moodle-theme_nimble github]
|-
| Nonzero
| [https://moodle.org/plugins/view.php?plugin=theme_nonzero plugins db]
| [https://github.com/moodlehq/moodle-theme_nonzero github]
|-
| Overlay
| [https://moodle.org/plugins/view.php?plugin=theme_overlay plugins db]
| [https://github.com/moodlehq/moodle-theme_overlay github]
|-
| Serenity
| [https://moodle.org/plugins/view.php?plugin=theme_serenity plugins db]
| [https://github.com/moodlehq/moodle-theme_serenity github]
|-
| Sky High
| [https://moodle.org/plugins/view.php?plugin=theme_sky_high plugins db]
| [https://github.com/moodlehq/moodle-theme_sky_high github]
|-
| Splash
| [https://moodle.org/plugins/view.php?plugin=theme_splash plugins db]
| [https://github.com/moodlehq/moodle-theme_splash github]
|-
| Standard
| [https://moodle.org/plugins/view.php?plugin=theme_standard plugins db]
| [https://github.com/moodlehq/moodle-theme_standard github]
|-
| Standard old
| [https://moodle.org/plugins/view.php?plugin=theme_standardold plugins db]
| [https://github.com/moodlehq/moodle-theme_standardold github]
|}

Note: Only installed additional themes are updated automatically during the upgrade, NOT standard themes. Because standard themes have been removed from Moodle 2.7, they have to be re-added.

===Questions engine upgrade===

In Moodle 2.1, there was a major overhaul of the Question engine. As explained in [https://docs.moodle.org/21/en/Upgrading_to_Moodle_2.1#Planning_the_question_engine_upgrade the upgrade documentation for that version], it was possible to delay parts of the database upgrade to be run later. Before you upgrade to Moodle 2.7, this upgrade must be completed.

This will affect you if...
* your site started off on a version of Moodle 2.0.x and
* when you upgraded to Moodle 2.1 or 2.2, you made use of the complex facility to delay part of the question engine upgrade (as explained in [https://docs.moodle.org/21/en/Upgrading_to_Moodle_2.1#Planning_the_question_engine_upgrade the upgrade documentation for that version]) and
* you still have not completing that upgrade
...then you must complete it before upgrading to Moodle 2.7.

You can check by looking at the bottom of the [[:en:Environment|Environment]] page in your site, providing you are running a version later than 2.4.9, 2.5.5 or 2.6.2. If you have a problem, it will tell you there. If there is no mention of questions there, you can forget about this.

This is unlikely to affect most users.

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

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

== 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 2.7 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.

== Install the new Moodle software ==

=== 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 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.
# Dont forget to also copy over your moodledata folder / directory. If you don't you will get a "fatal error $cfg- dataroot is not configured properly".

====Linux====
mv moodle moodle.backup
tar xvzf moodle-2.7.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.

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.

=== 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 2.7 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.

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 2.7 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 2.7 config-dist.php.

===Cron===

Cron has received a major update (MDL-25499) and now has support for both scheduled and adhoc 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 to 2.7, 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 to 2.7.

===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 2.7 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 2.7, and then replace the "mod/assignment" folder with the one from https://github.com/moodlehq/moodle-mod_assignment/releases before completing the upgrade.

===Maths filters===

Moodle 2.7 comes with a new maths filter based on [http://mathjax.org MathJax]. It is an alternative to the existing Tex filter. The MathJax filter is enabled by default for new sites, but not for upgrades. You may wish to disable the Tex filter and enable the MathJax filter. There are some compatibility settings and other options that can be changed for the [[MathJax filter]].

==Possible issues that may affect you in Moodle 2.7==

''Items to be added here...''

===Custom log-based reports===

Moodle 2.7 has moved to the new Logging API that allows more detailed and more flexible log storage. By default after the upgrade Moodle no longer stores data in table 'log'. All standard reports and plugins that used to access this table are converted to support both new API and legacy 'log' table. It is understandable that there might be custom 3rd party plugins that can not be changed immediately and either write significant information to the 'log' table or require access to it. In this case admin needs to enable writing to the legacy log:
Site Administration > Plugins > Logging > Legacy log : Select "Log legacy data". You might also want to disable "Standard log" so your system doesn't have double logging.

=== Moodle 2.3, 2.4, 2.5 and 2.6 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/23/en/Upgrading Upgrading to Moodle 2.3]
* [https://docs.moodle.org/24/en/Upgrading Upgrading to Moodle 2.4]
* [https://docs.moodle.org/25/en/Upgrading Upgrading to Moodle 2.5]
* [https://docs.moodle.org/26/en/Upgrading Upgrading to Moodle 2.6]

==See also==

* [[Installation]]
* Using Moodle [http://moodle.org/mod/forum/view.php?id=28 Installation problems forum]
* [[dev:Moodle 2.7 release notes|Moodle 2.7 release notes]]
* [[dev:Upgrade API|Upgrade API]]

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

Sandbox

2014-06-16T16:27:57Z

Poltawski: /* Testing gallery */

Test page for docs

Testing email notification

-Testing-

{| cellpadding="2" cellspacing="0" border="1"
!Col1
!Col2
|-
|Test1
|Test2
|-
|Test1
|Test2
|-
|Test1
|Test2
|}

==Functions and Examples==

Following are the functions that constitute the basic log API for Moodle.
<code>
add_to_log($courseid, $module, $action, $url='', $info='', $cm=0, $user=0)
user_accesstime_log($courseid=0)
get_logs($select, array $params=null, $order='l.time DESC', $limitfrom='', $limitnum='', &$totalcount)
get_logs_usercourse($userid, $courseid, $coursestart)
get_logs_userday($userid, $courseid, $daystart)
</code>
The basic working of these functions can be categorized in two categories:-
# Adding data to logs
# Fetching data from logs
Let us take a deeper look into both of these:-

<pre>something in pre tags</pre>

==Testing gallery==
<gallery mode="packed-hover">
File:Atto_27.jpg|Atto
File:Clean27.jpg|Clean
File:MathJax.jpg|MathJax
</gallery>

Sandbox

2014-06-16T16:25:28Z

Poltawski: Testing gallery

Template:Infobox plugin

2014-06-11T19:51:44Z

Poltawski: Removed inline styles and coverted to new theme format. MDLSITE-3140

<div class="sideblock">
{| class="infobox"
|-
! '''[[{{PAGENAME}}]]'''
|-
| Type
| {{{type}}}
|-
| Set
| {{{set|N/A}}}
|-
| Downloads
| {{{entry}}}
|-
| Issues
| {{{tracker}}}
|-
| Discussion
| {{{discussion}}}
|-
| Maintainer(s)
| {{{maintainer}}}
|-
|}
</div>
<noinclude>
Copy and complete the following code to obtain an infobox listing details of the plugin:
<pre style="width:40em">
{{Infobox plugin
|type = Enter the plugin type e.g. activity, block, filter
|set = (optional) Enter the plugin's set link
|entry = Enter the plugins directory link
|tracker = Enter the Tracker CONTRIB component link
|discussion = Enter the link to the forum or discussion thread
|maintainer = [[User:Maintainer name|Maintainer name]]
|float = (optional) Enter right or left to make the info box float to the respective side.
}}
</pre>

Note: If there is not yet a discussion thread about the plugin, please create one in the [http://moodle.org/mod/forum/view.php?id=44 General add-ons forum].

This template will also categorize articles that include it as [[:Category:Add-on]].</noinclude>
<includeonly>[[Category:Add-on]]</includeonly>

Installing MSSQL for PHP

2014-05-28T14:14:46Z

Poltawski: Nicer table styling

{{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!]
|-
| 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]]

Admin bookmarks block

2014-04-25T01:40:52Z

Poltawski: MDL-43521 has been fixed.

{{Blocks}}
This block allows an administrator to bookmark site admin pages for easy access. These include the Notifications and Add/Edit courses pages. The administrator will then see the pages as a list of links.

Note: Only site admin pages can be bookmarked i.e. pages accessed via ''Administration > Site administration''.

When on a page which may be bookmarked, the block shows 'bookmark this page'. (1) Once bookmarked, the block shows the page name with a link and "Unbookmark this page". (2) When on a different site admin page, other links are shown with 'Bookmark this page' available for the current page. (3) When on a bookmarked page, the block shows current bookmarked links and the option to 'Unbookmark this page.' (4)

[[File:abookmarks1.png]]

The admin bookmarks block is shown by default on all pages which can be bookmarked. An admin may choose to add the admin bookmarks block to their [[My home]] page or the front page (selecting 'Display on the front page only').

Note: Although an admin can add the admin bookmarks block to the front page of their site and make it display throughout the entire site, this is not recommended, since it results in teachers seeing the block when they turn editing on in their course.

[[de:Administratorlesezeichen]]
[[es:Bloque de marcadores para Admin]]

Upgrading

2013-05-15T11:11:49Z

Poltawski: /* Course listing improvements */

Upgrading

2013-05-03T14:04:46Z

Poltawski: Added a very quick note about bcrypt + php, needs better wording.

error/debug/cannotdowngrade

2013-04-16T12:23:55Z

Poltawski:

This error occurs when a new version of a add-on has been installed at some point and then has been replace by an older version of the same add-on.

In this scenario you need to determine what has caused this to happen:

* It might be that you've accidentally tried to install a version compatible with older versions of Moodle. In this case, check the Moodle plugins database for the correct version with your Moodle and install this
* It could also be that the plugin is deffective - in this case you should try to contact the plugin author, using the Moodle forums for example.

error/debug/cannotdowngrade

2013-04-16T12:22:15Z

Poltawski: /* what to do */

This error occurs when a new version of a plugin has been installed at some point and then has been replace by an older version of the same plugin.

In this scenario you need to determine what has caused this to happen. It might be that you've accidentally tried to install a version compatible with older versions of Moodle.

error/debug/cannotdowngrade

2013-04-16T12:22:03Z

Poltawski: /* Error condition */

Talk:Category enrolments

2013-01-09T06:06:33Z

Poltawski: Created page with "I desperately tried to make this page more understandable because having just tried to use this plugin I was perplexed by how to use it. I'm afraid I couldn't think of a way of s..."

I desperately tried to make this page more understandable because having just tried to use this plugin I was perplexed by how to use it. I'm afraid I couldn't think of a way of succinctly explaining it. I do know how this plugin works now though, so if anyone would like to know how it works (and improve the documentation) please feel free to ask me. --[[User:Dan Poltawski|Dan Poltawski]] 14:06, 9 January 2013 (WST)

Category enrolments

2013-01-09T06:04:11Z

Poltawski:

{{Enrolment}}

The category enrolments plugin allows users to be enrolled in a category as opposed to individual courses. The plugin has to be enabled by the site administrator (see [[Enrolment plugins]]). The category enrolment plugin will synchronise any role assignments at category context with 'enrol/category:synchronised' permission set to allow.

Note: It is recommended that [[Cohort sync]] is used in preference to category enrolments. There are performance issues with category enrolments. See http://tracker.moodle.org/browse/MDL-23840.

==Settings for category enrolment==

*Go to the category into which you wish to enrol users. '''Note:''' You need to have category rights (manager or administrator)

*In the ''Settings'' box,click ''Assign roles''. The list of possible roles you can assign will appear:
[[File:Categoryassign.png]]

== Admin settings for category enrolment==

The category enrolment plugin may be enabled or disabled throughout the site in ''Settings > Site administration > Plugins > Enrolments> Manage enrol plugins.''

===Assigning teachers or students to a category===

*By default, only managers and course creators can be assigned category-wide. If you want to add teachers or students then the site administrator needs to tick the "category" box in their role in ''Settings > Site administration > Users > Permissions > Define roles''.
*To ensure they will be automatically assigned as teachers/students in any new courses you make, the administrator needs to set to "allow" the capability ''enrol/category:synchronised'' for the role in question in ''Settings > Site Administration > Users > Permissions > Define roles''

[[File:Enrolcategorysync.png]]

[[ja:カテゴリ登録]]
[[de:Kursbereichseinschreibung]]

error/moodle/invalidrecord

2012-12-14T07:52:38Z

Poltawski:

This error was probably caused by a record not existing in the database

[[Category:Error|Invalidrecord]]

Caching

2012-12-13T04:34:27Z

Poltawski: Very basic overview of the cache settings. This is not great. I've filled MDL-37145 to improve this further.

{{Performance}}{{New features}}

A cache is a collection of processed data that is kept on hand and re-used in order to avoid costly repeated database queries.

Moodle 2.4 saw the implementation of MUC, the Moodle Universal Cache. This new system allows certain functions of Moodle (eg string fetching) take advantage of different installed cache services (eg files, ram, memcached).

In future versions of Moodle we will continue expanding the number of Moodle functions that use MUC, which will continue improving performance, but you can already start using it to improve your site.

==General approach to performance testing==

Here is the general strategy you should be taking:

# Build a test environment that is as close to your real production instance as possible (eg hardware, software, networking, etc)
# Make sure to remove as many uncontrolled variables as you can from this environment (eg other services)
# Use a tool to place a realistic, but simulated and repeatable load upon you server. (eg jmeter or selenium).
# Decide on a way to measure performance of the server by capturing data (ram, load, time taken, etc)
# Run your load and measure a baseline performance result.
# Change one variable at a time, and re-run the load to see if performance gets better or worse. Repeat as necessary.
# When you discover settings that result in a consistent performance improvement, apply to your production site.

==How to use the caching settings==

Since Moodle 2.4, Moodle has provided a caching plugin framework to give administrators the ability to control where Moodle stores cached data. For most Moodle sites the default configuration should be sufficient and it is not necessary to change the configuration. For larger Moodle sites with multiple servers, administrators may wish to use memcached, mongodb or other systems to store cache data. The cache plugin screen provides administrators with the ability to configure what cache data is stored where.

=== Types of cache ===

Moodle uses three types of cache to store cached data:
* Request cache - The request cache is available for the duration of every page request. It is not shared between users and is used and cleared on every Moodle request.
* Session cache - The session cache is available through a users session in Moodle. It is not shared between users, but persists for a single user throughout their session (i.e. from when they logon til when they log off)
* Application cache - The application cache is a shared cache which is available for every request. It can be shared between users and the cached data can be kept indefinitely if required.

===Installed cache stores===

This section of the administrator screen displays cache plugins which are installed on the system. It lists what the capabilities of each plugin, what type of cache they provide and provides allows a cache store to be added to the system.

===Configured store instances===

This section of the administrator screen displays cache stores which have been added to the system. It gives the ability to change the cache configuration and purge the cached data.

===Known cache definitions===

Known cache definitions displays the caches which are in use by Moodle. Each item is an area of Moodle which is using caching. It gives the administrator the ability to configure an individual area of Moodle to use a different cache backend. For example, an administrator of a Moodle cluster may choose to make language string definitions be cached on a dedicated memcached server by using the memcached cache backend.

==Stores used when no mapping is present==

This section displays the default cache stores which should be used by Moodle for each type of Moodle cache. If a mapping for a cache definition does not exist then this default store will be used instead.

==Other performance testing==

Two links that might be useful to anyone considering testing performance on their own servers:

* [http://www.iteachwithmoodle.com/2012/10/12/moodle-performance-testing-how-much-more-horsepower-do-each-new-versions-of-moodle-require/ Moodle performance testing: how much more horsepower do each new versions of Moodle require?]
* [http://www.iteachwithmoodle.com/2012/10/11/how-to-stress-test-your-moodle-server-using-loadstorm/ How to load test your Moodle server using Loadstorm]

==See also==

* Using Moodle [https://moodle.org/mod/forum/discuss.php?d=217195 MUC is here, now what?] forum discussion

Developer documentation:
* [[:dev:The Moodle Universal Cache (MUC)]]
* [[:dev:Cache API]]
* [[:dev:Cache API - Quick reference]]

{{stub}}
[[de:Caching]]

SSL certificate for moodle.org

2012-12-04T15:24:28Z

Poltawski: added rhel note, as I think the package name is the same

== Synopsis ==

Your site may communicate with moodle.org sites - for example when it [[Notifications|checks for available updates]] or when it [[Automatic updates deployment|installs an update]]. This communication is done via the secure HTTPS protocol. Your site validates the SSL certificate of the moodle.org site (such as the [https://moodle.org/plugins Moodle plugins directory]) and verifies its identity. To pass this verification, there must be a certificate (in the PEM format) of the [http://en.wikipedia.org/wiki/Certificate_authority certificate authority (CA)] that issued the certificate for moodle.org installed at your server.

The SSL certificate of moodle.org sites has been issued by the [https://www.digicert.com/digicert-root-certificates.htm DigiCert CA] and signed by their ''DigiCert High Assurance EV Root CA'' certificate.

== Problem ==

If this CA certificate is missing, the remote site (moodle.org) can not be verified and your Moodle refuses to fetch the data (to protect you against so called man-in-the-middle attack). The exact location of that certificate at your server depends on the OS type and other settings. At Linux servers it may be typically found at ''/usr/share/ca-certificates/mozilla/DigiCert_High_Assurance_EV_Root_CA.crt'' for example.

Missing CA certificate causes error when checking for available updates and attempting to install them.

== Solutions ==

=== Update your operating system (recommended) ===

The recommended way to fix this problem is to update your server's operating system so that it contains recent SSL certificates of common certificate authorities. At Debian and RedHat based distributions, these certificates are distributed in the ''ca-certificates'' package. Gentoo servers provide them via the ''app-misc/ca-certificates'' ebuild. It's also a good idea to make sure that the OpenSSL libraries (libssl) and cURL libraries (libcurl) are up-to-date at your server.

=== Provide the CA certificate manually ===

If updating the operating system is not an option for you and the administrator of the server refuses to update the CA certificates at the server (there's not a good argument for that though), here is a workaround for you. You can download the [https://www.digicert.com/testroot/DigiCertHighAssuranceEVRootCA.crt DigiCert High Assurance EV Root CA] certificate from [https://www.digicert.com/digicert-root-certificates.htm digicert.com] and put it into your ''moodledata/moodleorgca.crt'' file. If the certificate is found there, Moodle will use it instead of relying on the one provided by the operating system.

It must be highlighted that you really should get the CA certificate to your server's operating system as described above. The solution based on moodleorgca.crt should be considered as a temporary only.

Forum discussion subscription plugin

2012-09-04T01:20:58Z

Poltawski: remove duplicate link

== Description ==

Local plugin for allowing email subscription to discussions (threads) and not the whole forum.

Discussion subscription can works together with full forum subscription, but the user will receive the same emails two times.

Discussion subscription supports also diggest if the user has enabled this option in his profile.

== Configuration ==

As a teacher, in the forum activity go to the settings block and click on "Discussion subscriptions" -> "Enable"

Once enabled, the users will be able to click on the "Subscribe to this discussion" in a discussion page.

== Credits ==

Juan Leyva <http://twitter.com/#!/jleyvadelgado>

http://moodle.org/user/profile.php?id=49568

== See also ==

http://moodle.org/plugins/view.php?plugin=local_dsubscription

https://github.com/jleyva/moodle-local_dsubscription

[[Category: Contributed code]]

Database transfer

2012-07-31T07:25:16Z

Poltawski:

{{Managing a Moodle site}}
The database transfer tool in Moodle 2.3.2 onwards enables an administrator to migrate their Moodle site from one database to another, for example from MySQL to Postgres.

The tool is currently classed as an experimental feature and may be found in ''Settings > Site administration > Development > Experimental > Database migration''. There is also a command line script in 'admin/tool/dbtransfer/cli/migrate.php'.

The dbtransfer tool uses the XMLDB schema definitions from Moodle and installed plugins to retrieve the data from one database and transfer it another.

==See also==

* MDL-34441 finish dbtransfer tool implementation

Using Moodle forum discussions:
* [http://moodle.org/mod/forum/discuss.php?d=207413 Moving Moodle from Oracle to PostgreSQL (dbtransfer tool)]
* [http://moodle.org/mod/forum/discuss.php?d=206759 Where did dbtransfer.php go?]

{{stub}}

Database transfer

2012-07-31T07:25:05Z

Poltawski: added some additional basic details

Database transfer

2012-07-31T07:18:48Z

Poltawski: i've removed the new feature in 2.3 flag, because its been there since 2.0, in various states.

Skydrive repository

2012-06-28T16:10:08Z

Poltawski: Created page with "The Microsoft Skydrive repository allows you to access your documents from Microsoft Skydrive within Moodle. ==Installation== You must register your Moodle with Microsoft in or..."

The Microsoft Skydrive repository allows you to access your documents from Microsoft Skydrive within Moodle.

==Installation==
You must register your Moodle with Microsoft in order to allow Moodle to communicate with Microsoft. You must register your application via the following steps:

# Visit the Microsoft developer centre: [https://manage.dev.live.com/Applications/Index https://manage.dev.live.com/Applications/Index]
# Choose ‘Create an Application’ and Fill out the form with a name for your Moodle.
# Submit the form by clicking ‘I Accept’
# On the next page you must visit the link ‘Application Settings Page’.
# You will be shown the basic settings page, Click ‘API Setttings’ on the left.
# You will be shown ‘client ID’ and ‘client secret’, these need to be stored in Moodle.
# Important: As part of the registration process, you will need to enter the url from the skydrive settings page in the 'redirect domain' section.

[[Category:Contributed code]]

User:Dan Poltawski

2012-06-28T14:29:49Z

Poltawski:

Please see my [http://moodle.org/user/view.php?id=104159&course=5 Moodle.org Profile] as I don't keep this one up to date.. (only just keep the other one up date :))

Upload users

2012-06-20T03:07:13Z

Poltawski: remove AJAX and Javascript MDL-32908

{{Accounts}}
An administrator can upload multiple user accounts via text file in ''Settings > Site administration > Users > Accounts > Upload users''.

There are many robust options for uploading information (fields associated with a user) with this method: from enrolling users in multiple courses with course specific [[Roles|roles]] to updating user information in the [[User profile]] to deleting users from the site.

{{New features}}Rather than uploading the text file, it can simply dragged from the desktop and dropped into the upload area, as demonstrated in the screencast [http://youtu.be/6E-TQXTkZB0 Drag and drop new users into Moodle 2.3] (by Mary Cooch).

''Tip:'' It is usually not necessary to upload users in bulk with Upload users. To keep maintenance work down you should first explore forms of authentication that do not require manual maintenance, such as [[External database authentication|connecting to existing external databases]] or letting the users create their own accounts ([[Self enrolment]]). See [[Authentication]] for more information.

[[File:Upload users initial 2.0.JPG|thumb|center|Initial upload users screen 2.1]]

==Upload user process==
Here is an outline of the process:

# Create file for uploading
# Go to ''Settings > Site administration > Users > Accounts > Upload users''
# Add file to upload
# Upload users preview - check settings and default user profile settings
# Upload users preview - click "Upload users"
# Upload users results - shows list of users, exceptions made in upload and summary of number of users
# Upload users results - click "Continue"
# Returns to Upload users screen

==Updating users preview==
There are settings for the kind of Upload user function you want to perform on the "Upload users preview" page.
[[File:Upload users preview 2.0.JPG|thumb|center|Upload users preview in Moodle 2.x]]

===Updating existing accounts===

By default Moodle adds new user accounts and skips existing users lines where the <code>username</code> matches an existing account. Set "Upload Type" to '''Add new and update existing users''', and existing user account will be updated.
*Add all, append number to usernames if needed
*Add new and update existing users
*Update existing users only
There are also fields settings to force password change, allow renames, allow deletes, prevent email address duplicates, standardise usernames and select for bulk operations(new users. updated users, all users).

'''Warning''': errors updating existing accounts can affect your users badly. Be careful when using the options to update.

===Set default user values===

You may be able to set default user field values, if the fields were not included in the uploaded file on this page.

==Upload user results ==
After accepting the preview settings by clicking on "Upload users", you should see the the Upload users results screen.
[[File:Upload users results 2.0.JPG|thumb|center|The 2.0 results screen, everything went well]]
This screen will show you any exceptions or changes that were made to each user in the upload process. For example if you were updating user information, the updated information will be shown. Or if a user was not added that record will be highlighted.

The screen will summarize how many users were uploaded or updated, indicate the number of weak passwords and the number of errors.

==File formats for upload users file==
The upload files have their fields separated by a comma (or other delimiter). The first line contains the valid field names. The rest of the lines (records) contain information about each user.

'':Tip:'' If you are not an expert, avoid special characters in field information like quotes or other commas. Test a file with only one record before a large upload. Remember there are other ways to authenticate users on you site or enroll users in a course.

'':Tip:'' You can use a spread sheet program to create the file with the required columns and fields. Then save the file as "CSV (comma delimited)". These files can be opened with simple text editors for verification.

===Valid upload file for testing===
Here is an example of a simple valid upload file:

<code>username, password, firstname, lastname, email, course1, group1, cohort1 
jonest, verysecret, Tom, Jones, jonest@someplace.edu, math102, Section 1, year 3 
reznort, somesecret, Trent, Reznor, reznort@someplace.edu, math102, Section 3, year 4</code>

===Fields that can be included===
'':Tip:'' We strongly recommend that you test a file that contains fields you proposed to use with one user before attempting a file upload for the first time. demo.moodle.net might be a good place to see if your test file works.

*'''Required fields''':
:<code>username, firstname, lastname, email</code>
:Validity checks are performed for:
#<code>username</code> can only contain alphabetical '''lowercase''' letters , numbers, hypen '-', underscore '_', period '.', or at-sign '@'
#<code>email</code> is in the form: ''name@example.com'' .

*'''Password field''': "password" field is optional if "Create password if needed" setting is chosen (default).
**If included, values should meet the requirements for the site's [[Site_policies#Password_policy|Password policy]]. To force password change for a particular user, set the password field to <code>changeme</code>.
**If omitted, a password will be generated for each user (during the next Cron job) and welcome e-mails sent out (not working in v2.0.2?).
**Note: the text for the welcome e-mail is in the language settings.

*'''Optional fields''': To provide values other than the default include one or more of these
:<code>institution, department, city, country, lang, auth, timezone, idnumber, icq, phone1, phone2, address, url, description, mailformat, maildisplay, htmleditor, autosubscribe</code>
*Country- use a country TWO LETTER CODE
*Some fields have a maximum number of characters that are allowed (notably institution should be '''at most 40 characters''' long). See hints below.
*Maildisplay, htmleditor and autosubscribe can be set from an import screen in Moodle 2.0.

*'''Custom profile field names''': (Optional). xxxxx is the real custom user profile field name (i.e. the unique shortname)
:<code>profile_field_xxxxx</code>
: Create the custom fields BEFORE importing. Use the standard header. The "shortname" for your custom field is xxxxx (NB: as at v2.0.2, the shortname must be all lowercase, otherwise won't be recognised). The first record must include "profile_field_xxxxx".

:'''Example''': To create a custom field "genre", you must write a shortname "genre" in the new field, and write "profile_field_genre" in the header of the .csv file.

: For custom profile fields that are a menu, use the corresponding menu number (index).

:'''Example''': if your custom field is department and there are three choices - HR, Marketing,Training- then HR would be 0, Marketing would be 1, and Training would be 2.

*'''Special fields''': Used for changing of usernames or deleting of users
:<code>oldusername</code>, <code>deleted</code>

*'''Enrolment fields''': (Optional):
:<code>course1, type1, role1, group1, enrolperiod1, course2, type2, role2, group2, enrolperiod2</code> etc.

:*<code>course</code> is the "shortname" of the course, if present the user will be enrolled in those courses.
:* <code>type</code> refers to the role to be used for associated course enrolment. Value 1 is default course role, 2 is legacy Teacher role and 3 is legacy Non-editing Teacher.
:* You can use role field instead to specify roles directly - use either role short name or id (numeric names of roles are not supported).
:* Users may be also assigned to groups in course (group1 in course1, group2 in course2, etc.).
:* A group is identified by name or id (numeric group names are not supported)
:* You can set the enrolment duration, in days, for each course (<code>enrolperiod1</code> for <code>course1</code>, <code>enrolperiod2</code> for <code>course2</code>, etc.).

*'''Cohort field''': (Optional):
:<code>cohort1</code>

:Cohort ids (not names) of existing cohorts must be used

Commas within a field must be encoded as &#44 - the script will decode these back to commas.

For Boolean fields, use <code>0</code> for false and <code>1</code> for true.

To prevent users from receiving a large number of emails from courses or forced subscription forums use the '''maildigest'''. The options for this field are 0 = No digest, 1 = Complete digest and 2 = Digest with just subjects.

==Advanced potentials of Upload user==
===Templates===

''Note: This section needs checking and updating if necessary for Moodle 2.0. Please do so and remove this note when finished.''

The default values are processed as templates in which the following codes are allowed:

* %l - will be replaced by the lastname
* %f - will be replaced by the firstname
* %u - will be replaced by the username
* %% - will be replaced by the %

Between the percent sign (%) and any code letter (l, f or u) the following modifiers are allowed:

* (-) minus sign - the information specified by the code letter will be converted to lowercase
* (+) plus sign - the information specified by the code letter will be converted to UPPERCASE
* (~) tilde sign - the information specified by the code letter will be converted to Title Case
* a decimal number - the information specified by the code letter will be truncated to that many characters

For example, if the firstname is John and the lastname is Doe, the following values will be obtained with the specified templates:

* %l%f = DoeJohn
* %l%1f = DoeJ
* %-l%+f = doeJOHN
* %-f_%-l = john_doe
*<nowiki> http://www.example.com/~%u/</nowiki> results in <nowiki>http://www.example.com/~jdoe/</nowiki> (if the username is jdoe or %-1f%-l)

Template processing is done only on default values, and not on the values retrieved from the CSV file.

In order to create correct Moodle usernames, the username is always converted to lowercase. Moreover, if the "Allow extended characters in usernames" option in the Site policies page is off, characters different to letters, digits, dash (-) and dot (.) are removed. For example if the firstname is John Jr. and the lastname is Doe, the username %-f_%-l will produce john jr._doe when Allow extended characters in usernames is on, and johnjr.doe when off.

When the "New username duplicate handling" setting is set to Append counter, an auto-increment counter will be append to duplicate usernames produced by the template. For example, if the CSV file contains the users named John Doe, Jane Doe and Jenny Doe without explicit usernames, the default username is %-1f%-l and New username duplicate handling is set to Append counter, then the usernames produced will be jdoe, jdoe2 and jdoe3.

===Deleting accounts===

If the <code>deleted</code> field is present, users with value 1 for it will be deleted. In this case, all the fields may be omitted, except for <code>username</code>. After uploading the file, be sure to change the "Upload type" to "Update existing users only" and the "Allow deletes" option to "Yes".

Deleting and uploading accounts could be done with a single CSV file. For example, the following file will add the user Tom Jones and delete the user reznort:

username, firstname, lastname, deleted
jonest, Tom, Jones, 0
reznort, , , 1

==Encoding file format==
On the initial Upload user screen, you may select the file encoding format from a pull down list. These include UTF-8 (the default), ASCII, ISO-8859-1 to ISO-8859-11 or any one of over 36 formats.

==Hints==

===Spreadsheet===

If you use a spreadsheet program such as Excel to create your .csv file, check the resulting output in a text editor before you upload it. It is possible to get trailing commas on each line from an empty field if you have added and deleted columns of information prior to saving the final file. Also check the character encoding. A csv file is a simple text file (ASCII or Unicode) that can be used to upload user accounts.

Excel translates passwords that begin with - (minus) or + (plus) as zero. Even when saving as .csv and saying "Yes" to "Keep this format, and leave out any incompatible features." Check for this before uploading, as a zero halts the upload process.

If you use a formula in Excel to create fields (for example, the concatenate function to create a user name), then remember to copy the cells with the formula and use special paste with values checked to make them into an acceptable data for a csv file.

===Country===
The country should be written as a two letter code, in capitals. For example, use BE for Belgium or NL for the Netherlands. Using "be" or "nl" as a country code will result in a database error.
:''Tip:'' If you are having trouble working out the two-letter code for a country, you can consult this Moodle source code file /moodle/lang/en_utf8/countries.php [http://cvs.moodle.org/moodle/lang/en_utf8/countries.php?view=markup&pathrev=MOODLE_19_STABLE or click here for a 1.9 STABLE list].
ISO Website: [http://www.iso.org/iso/country_codes/iso_3166_code_lists/english_country_names_and_code_elements.htm]
===Field size limits===
Some fields have maximum character lengths. Typically the file will import to the preview list screen but not finish the process. Turn on debug to see the fields that are too long. Common fields to cause problems are "Institution" which is limited to 40 characters, and "City", also limited. The error will be "User not added - error".

===All fields listed here===
:All the fields that are valid are listed below, except for any custom fields you may have created.
firstname, lastname, username, email, city, country, lang, timezone, mailformat, maildisplay, maildigest, htmleditor, ajax, autosubscribe ,institution, department, idnumber, skype , msn, aim, yahoo, icq, phone1, phone2, address, url, description, descriptionformat, password, auth, oldusername , deleted, course1, course2, course3, course4

== See also ==

*[[Flat file]] enrolment
* [[User profile fields]] for details of how to include data about custom user profile fields in the upload users file

Using Moodle forum discussions:
*[http://moodle.org/mod/forum/discuss.php?d=36851 Can I auto enroll from Excel?]
*[http://moodle.org/mod/forum/discuss.php?d=97903 Uploading users to custom roles]
*[http://moodle.org/mod/forum/discuss.php?d=181259 User upload option: standardise usernames]
*[http://moodle.org/mod/forum/discuss.php?d=144569 Matriculacion con flat file csv] - discussion in Spanish

[[fr:Importer des utilisateurs]]
[[ja:ユーザのアップロード]]
[[de:Nutzerliste hochladen]]

Add a new user

2012-06-20T03:04:01Z

Poltawski: remove AJAX and Javascript MDL-32908

{{Accounts}}
An administrator or manager (or any other user with the capability [[Capabilities/moodle/user:create|moodle/user:create]]) can create new user accounts in ''Settings > Site administration > Users > Accounts > Add a new user''. (To add users in bulk, see [[Upload users]].)

[[File:Addanewuser.png]]

==General==

===Username===
The user will use this username to log in to the Moodle instance. It needs to be unique. This may be changed. A user's name can only contain alphabetical letters in lowercase, numbers, hyphen '-', underscore '_', period '.', or an at character '@'.

===Authentication method===
The setting specifies how Moodle will check whether the user's specified password is correct.

Accounts created by an administrator use the '''Manual Accounts''' method, and accounts created by the user themselves using the email sign-up method use the E-mail based self-registration method.

===Suspended account===

Suspended user accounts cannot log in or use web services, and any outgoing messages are discarded.

===Password===
This is the user's password. It is subject to the password policy in [[Site policies]]. A user can change their password by the ''Settings block > My Profile settings > Change password'' link.

===First Name===
The user's first name. It is displayed along with the last name in messages, forum posts, participants list, reports and anywhere where something about the user is shows on the page.

===Surname===
The user's surname. It is displayed along with the first name in messages, forum posts, participants list, reports and anywhere where something about the user is shows on the page.

===Email address===
Password reset notices, forum digests and other messages are sent to this email address from the Moodle site.

===Email display===
This setting controls who can see the user's email address.

===Email format===
This setting can be used such that Moodle will send text-only emails to the user.

===Email digest type===
This setting set whether the user will receive an email for each new forum post in subscribed forums, or if new posts should be sent once per day in a digest, and which type of digest.
* No digest (one receives individual emails),
* Complete (a single digest daily) or
* Subjects (a single digest daily with only the post topics included).

===Forum auto-subscribe===
If a user subscribes to a forum, new posts will be sent in the digest as specified. This setting sets whether a user is automatically subscribed to forums or if a manual click on the subscription button in each forum is required.

===Forum tracking===
THis setting specifies whether new posts written since the user's last visit should be highlighted as such.

===When editing text===
This setting specifies whether the user prefers to see the WYSIWYG text editor or just a plain text box.

===Screen Reader===
Enabling this setting will improve the display of Moodle to make it more compatible with screen readers.

===City/town===
The user's city or town

===Country===
The user's country

Note: City and country defaults may be set in ''Settings > Site administration > Location > Location settings''.

===Timezone===
This setting is used to adjust the times of messages and assignment/quiz due dates to match the user's local time

===Preferred language===
This will cause the Moodle interface to be displayed in the specified language. (See [[Language packs]])

Note: Content will not be translated automatically, but if multi-language content is entered the appropriate language content will be displayed, if available.

===Description===
Information about the user that other users can see.

==User Picture==
The user's picture can be displayed next to the user's name next to any content he/she has posted in Moodle activities such as the forum. See [[User pictures]] and [[Gravatars]] for details.

==Interests==
The list of interests can be used as a way of connecting users with similar interests. [[Tags]] must be enabled on the site.

==Optional==
There are several optional fields that come with an standard install. These include:
Web Page, ICA number, Skype ID, AIM ID, Yahoo ID, MSN ID, ID number, Institution, Department, Phone, Mobile Phone, Address.

The site administrator may [[User profile fields|add more custom fields]] and/or turn off any of these "optional" fields.

[[de:Nutzer/in neu anlegen]]

Update profile

2012-06-20T03:03:36Z

Poltawski: remove AJAX and Javascript MDL-32908

{{Accounts}}
==Editing Your Profile ==

Administrators can update user profiles via ''Administration > Users > Accounts > Add a new user'' or ''Browse list of users'' and individual users may update their profiles by choosing the ''Edit profile'' link from ''Settings>My profile settings''

The fields are divided into 3 sections - General, Picture & Optional which are all explained below. Note that some settings are 'advanced', so you may need to click the 'Show Advanced' button on the right to see all the settings. The advanced settings are indicated below.

Remember to click 'Update profile' when you have finished.

=== General ===

The first section contains fields that must be completed:

'''First name & Surname'''

These are self-explanatory. These names will identify you everywhere in your Moodle courses.

'''Email address'''

The email address should be an address that you check regularly. It is used for acknowledgements and announcements from Moodle, including messages from Forums that you are subscribed to. It is also the address that is displayed to other users of Moodle, depending on your 'Email display' setting (below).

'''Email display'''

This controls the visibility of your email address to others. The three settings are self-explanatory but please note 'Hide my email address from everyone' only hides it from students. Teaching staff and other staff with editing access will always be able to see your email address.

'''Email format (advanced)'''

There are two formats: "Pretty HTML format" (messages will be formatted) and "Plain text format" (plain text with no formatting).

'''Email digest type (advanced)'''

This setting determines how you receive any posts from Forums to which you are subscribed, allowing you to receive messages individually or on a daily basis.

'''Forum auto-subscribe (advanced)'''

This setting lets you decide if you want email copies of posts that are added to forums. If you set this to subscribe, the system will automatically email you copies of new posts in forums that you post in, unless you manually override it when posting.

'''Forum tracking (advanced)'''

Enabling forum tracking means highlighting the posts you have not read yet, which should improve your forum navigation.

'''When editing text (advanced)'''

This can usually be left on "Use HTML editor (some browsers only)". This allows for text formatting options, but requires newer browsers. If you find your browser is not letting you edit text, change this setting to "Use standard web forms".

'''Screen Reader (advanced)'''

If you use a screen reader, this setting should be set to 'Yes'. (A screen reader is a form of 'assistive technology' used by blind and partially-sighted users to interpret what is displayed on the screen).

The screenreader variable is used in:

* /mod/chat/ - if screenreader is enable, chat window will be set to use gui_basic
* /mod/course/report/progress/ - check for svg to rotate text
* /admin/mnet/mnet_themes.html - use to ignore or print theme images
* /user/ - set the value for screenreader
* /grade/report/grader/ - use to set fixed layout
* /question/type/multianswer/ - used to print feedback icon and print an gap icon for question (MDL-7497)

'''City/town & Country'''

Add your location.

'''Timezone'''

This field is used to convert time-related messages on the system (such as assignment deadlines) from the local timezone (the time in London) to the correct time in whichever zone you have selected.

'''Preferred language and theme (advanced)'''

You can view Moodle in several different languages and colour themes, which you can select via these two options. Note: changing the preferred language only affects the Moodle interface, not the course content!

'''Description'''

In this field you can enter some text about yourself, be it information about your studies, hobbies, qualifications or anything else.

=== User picture ===

This section is optional and allows you to choose your own profile picture. Your current picture is shown, if you have already chosen one.

Note: If the admin has enabled it in ''Settings > Site Administration > Users > Permissions > User policies'', a gravatar you might have attached to your email account will appear as your profile image if you don't upload a different one. See [[Gravatars]] for details.

'''New picture'''

The "Choose a file" button allows you to choose a new picture for your profile. The picture must be in JPG or PNG format (ie the names will usually end in .jpg or .png).

To upload an image, click the "Upload a file" button from the list in the [[File_picker]], and select the image from your hard disk.

NOTE: Make sure that the file is not larger than the maximum size listed, or it will not be uploaded.

Then click "Update Profile" at the bottom - the image file will be cropped to a square and resized down to 100x100 pixels.

When you are taken back to your profile page, the image might not appear to have changed. If this is so, just use the "Reload" button in your browser.
==Interests==
Use tags here to display your interests on your profile page.

=== Optional ===

There are several optional fields (all advanced) allowing you to add further details to your profile such as contact details and your website.

===Custom Profile Categories===
If any custom user profile categories and fields have been created on your Moodle site, they will be listed at the bottom of the [[User profile fields|Admin >Accounts>User profile fields]]

==Updating a user profile==

Users with the capability [[Capabilities/moodle/user:update|moodle/user:update]] are able to update another user's profile i.e. in addition to being able to edit the profile, all settings (username, password, authentication method, force new password etc.) may be changed.

==Account disabling==

An account may be disabled by setting the authentication method to "[[No login]]". The account email may not be used to create another account.

==See also==

*[[User profiles]]

[[fr:Modifier le profil]]
[[de:Nutzerprofil aktualisieren]]

Google OAuth 2.0 setup

2012-06-07T06:26:42Z

Poltawski: Converting to thumnails. This view still sucks though. I'm not a mediawiki guru.

Prior to Moodle 2.3, Google Docs and Picasa repository plugins and portfolio plugins could be used without any configuration or registration with Google. In April 2012, [http://googledevelopers.blogspot.com/2012/04/changes-to-deprecation-policies-and-api.html Google announced] to web application developers that they would be deprecating the service which Moodle was using to communicate with Google and strongly advised developers to move away from it. As a response to this change with Google's service, Moodle switched to use a new system for communicating with Google called 'OAuth 2.0'. The OAuth 2.0 system providers and a better security system and more friendly experience to Moodle users, though it requires some additional configuration in Moodle.

==Registering with Google==
Each Moodle site now needs to be registered with Google in order to use the Google Docs or Picasa plugins. The following will guide you through the process of registering with Google.

# You will need to be signed into a google account
# Visit the [Google API's Console https://code.google.com/apis/console#access]
# You will be asked to create a project if this is your first time using this form. [[Image:google_oauth1.png|thumb|3. creating API Project]]
# You need to click the button marked 'Create an OAuth 2.0 client ID..' [[File:google_oauth2.png|thumb|4. creating an OAuth 2.0 Client ID]]
# You will be asked to enter branding information including a 'Product name' and 'Product logo'. By providing a descriptive name and link to distinct image then your users will know they are signing into the correct place. [[File:google_oauth3.png|thumb|5. client Settings]]
# Next you will be asked for 'Client ID Settings'
## For Application type, select 'Web application'
## Next to 'Your site or hostname' click '(more options)'
## In 'Authorized Redirect URIs' enter the URL which was provided in your Moodle settings page. (usually http://yourmoodle/admin/oauth2callback.php)
## In 'Authorized JavaScript Origins' leave the field blank [[File:google_oauth4.png|thumb|9. callback options]]
# Click 'Create client ID'
# Your site is now registered with Google and you will be presented with your details. [[File:google_oauth5.png|thumb|12. registered details]]
# Enter the 'Client ID' and 'Client secret' provided into your Moodle settings page

==Resulting Authorisation Screen==
Once configured, Google will present Moodle users with a nice authorisation screen with your moodle name and logo for your users to authorise:
[[File:google_oauth6.png]]

Google OAuth 2.0 setup

2012-06-07T06:17:16Z

Poltawski: slightly improved the initial sentence so it sounds less like I was smoking something whilst authoring it. ;-)

Prior to Moodle 2.3, Google Docs and Picasa repository plugins and portfolio plugins could be used without any configuration or registration with Google. In April 2012, [http://googledevelopers.blogspot.com/2012/04/changes-to-deprecation-policies-and-api.html Google announced] to web application developers that they would be deprecating the service which Moodle was using to communicate with Google and strongly advised developers to move away from it. As a response to this change with Google's service, Moodle switched to use a new system for communicating with Google called 'OAuth 2.0'. The OAuth 2.0 system providers and a better security system and more friendly experience to Moodle users, though it requires some additional configuration in Moodle.

==Registering with Google==
Each Moodle site now needs to be registered with Google in order to use the Google Docs or Picasa plugins. The following will guide you through the process of registering with Google.

# You will need to be signed into a google account
# Visit the [Google API's Console https://code.google.com/apis/console#access]
# You will be asked to create a project if this is your first time using this form. [[File:google_oauth1.png]]
# You need to click the button marked 'Create an OAuth 2.0 client ID..' [[File:google_oauth2.png]]
# You will be asked to enter branding information including a 'Product name' and 'Product logo'. By providing a descriptive name and link to distinct image then your users will know they are signing into the correct place. [[File:google_oauth3.png]]
# Next you will be asked for 'Client ID Settings'
## For Application type, select 'Web application'
## Next to 'Your site or hostname' click '(more options)'
## In 'Authorized Redirect URIs' enter the URL which was provided in your Moodle settings page. (usually http://yourmoodle/admin/oauth2callback.php)
## In 'Authorized JavaScript Origins' leave the field blank [[File:google_oauth4.png]]
# Click 'Create client ID'
# Your site is now registered with Google and you will be presented with your details. [[File:google_oauth5.png]]
# Enter the 'Client ID' and 'Client secret' provided into your Moodle settings page

==Resulting Authorisation Screen==
Once configured, Google will present Moodle users with a nice authorisation screen with your moodle name and logo for your users to authorise:
[[File:google_oauth6.png]]

Google OAuth 2.0 setup

2012-06-04T12:47:20Z

Poltawski:

Prior to Moodle 2.3, Google Docs and Picasa repository plugins and portfolio plugins could be used without any configuration or registration with Google. In April 2012, [http://googledevelopers.blogspot.com/2012/04/changes-to-deprecation-policies-and-api.html Google Announced] to web application developers that they would be deprecated the service which Moodle was using to communicate with Google and strongly advised developers to move away from it. As a response to this change with Google's service, Moodle switched to use a new system for communicating with Google called 'OAuth 2.0', starting with Moodle 2.3. The OAuth 2.0 system providers and a better security system and more friendly experience to Moodle users, though it requires some additional configuration in Moodle.

==Registering with Google==
Each Moodle site now needs to be registered with Google in order to use the Google Docs or Picasa plugins. The following will guide you through the process of registering with Google.

# You will need to be signed into a google account
# Visit the [Google API's Console https://code.google.com/apis/console#access]
# You will be asked to create a project if this is your first time using this form. [[File:google_oauth1.png]]
# You need to click the button marked 'Create an OAuth 2.0 client ID..' [[File:google_oauth2.png]]
# You will be asked to enter branding information including a 'Product name' and 'Product logo'. By providing a descriptive name and link to distinct image then your users will know they are signing into the correct place. [[File:google_oauth3.png]]
# Next you will be asked for 'Client ID Settings'
## For Application type, select 'Web application'
## Next to 'Your site or hostname' click '(more options)'
## In 'Authorized Redirect URIs' enter the URL which was provided in your Moodle settings page. (usually http://yourmoodle/admin/oauth2callback.php)
## In 'Authorized JavaScript Origins' leave the field blank [[File:google_oauth4.png]]
# Click 'Create client ID'
# Your site is now registered with Google and you will be presented with your details. [[File:google_oauth5.png]]
# Enter the 'Client ID' and 'Client secret' provided into your Moodle settings page

==Resulting Authorisation Screen==
Once configured, Google will present Moodle users with a nice authorisation screen with your moodle name and logo for your users to authorise:
[[File:google_oauth6.png]]

Google OAuth 2.0 setup

2012-06-04T12:41:51Z

Poltawski: /* Registering with Google */

Prior to Moodle 2.3, Google Docs and Picasa repository plugins and portfolio plugins could be used without any configuration or registration with Google. In April 2012, [http://googledevelopers.blogspot.com.au/2012/04/changes-to-deprecation-policies-and-api.html Google Announced] to web application developers that they would be deprecated the service which Moodle was using to communicate with Google and strongly advised developers to move away from it. As a response to this change with Google's service, Moodle switched to use a new system for communicating with Google called 'OAuth 2.0', starting with Moodle 2.3. The OAuth 2.0 system providers and a better security system and more friendly experience to Moodle users, though it requires some additional configuration in Moodle.

==Registering with Google==
Each Moodle site now needs to be registered with Google in order to use the Google Docs or Picasa plugins. The following will guide you through the process of registering with Google.

# You will need to be signed into a google account
# Visit the [Google API's Console https://code.google.com/apis/console#access]
# You will be asked to create a project if this is your first time using this form. [[File:google_oauth1.png]]
# You need to click the button marked 'Create an OAuth 2.0 client ID..' [[File:google_oauth2.png]]
# You will be asked to enter branding information including a 'Product name' and 'Product logo'. By providing a descriptive name and link to distinct image then your users will know they are signing into the correct place. [[File:google_oauth3.png]]
# Next you will be asked for 'Client ID Settings'
## For Application type, select 'Web application'
## Next to 'Your site or hostname' click '(more options)'
## In 'Authorized Redirect URIs' enter the URL which was provided in your Moodle settings page. (usually http://yourmoodle/admin/oauth2callback.php)
## In 'Authorized JavaScript Origins' leave the field blank [[File:google_oauth4.png]]
# Click 'Create client ID'
# Your site is now registered with Google and you will be presented with your details. [[File:google_oauth5.png]]
# Enter the 'Client ID' and 'Client secret' provided into your Moodle settings page

==Resulting Authorisation Screen==
Once configured, Google will present Moodle users with a nice authorisation screen with your moodle name and logo for your users to authorise:
[[File:google_oauth6.png]]

Google OAuth 2.0 setup

2012-06-04T12:40:48Z

Poltawski: /* Registering with Google */

Prior to Moodle 2.3, Google Docs and Picasa repository plugins and portfolio plugins could be used without any configuration or registration with Google. In April 2012, [http://googledevelopers.blogspot.com.au/2012/04/changes-to-deprecation-policies-and-api.html Google Announced] to web application developers that they would be deprecated the service which Moodle was using to communicate with Google and strongly advised developers to move away from it. As a response to this change with Google's service, Moodle switched to use a new system for communicating with Google called 'OAuth 2.0', starting with Moodle 2.3. The OAuth 2.0 system providers and a better security system and more friendly experience to Moodle users, though it requires some additional configuration in Moodle.

==Registering with Google==
Each Moodle site now needs to be registered with Google in order to use the Google Docs or Picasa plugins. The following will guide you through the process of registering with Google.

# You will need to be signed into a google account
# Visit the [Google API's Console https://code.google.com/apis/console#access]
# You will be asked to create a project if this is your first time using this form. [[File:google_oauth1.png]]
# You need to click the button marked 'Create an OAuth 2.0 client ID..' [[File:google_oauth2.png]]
# You will be asked to enter branding information including a 'Product name' and 'Product logo'. By providing a descriptive name and link to distinct image then your users will know they are signing into the correct place. [[File:google_oauth3.png]]
# Next you will be asked for 'Client ID Settings'
## For Application type, select 'Web application'
## Next to 'Your site or hostname' click '(more options)'
## In 'Authorized Redirect URIs' enter the URL which was provided in your Moodle settings page. (usually http://yourmoodle/admin/oauth2callback.php)
## In 'Authorized JavaScript Origins' leave the field blank [[File:google_oauth4.png]]
# Click 'Create client ID'
# Your site is now registered with Google and you will be presented with your details. [[File:google_oauth5.png]]
# Enter the 'Client ID' and 'Client secret' provided into your Moodle settings page

Once configured, Google will present Moodle users with a nice authorisation screen with your moodle name and logo for your users to authorise:
[[File:google_oauth6.png]]

File:google oauth6.png

2012-06-04T12:38:50Z

Poltawski:

Google OAuth 2.0 setup

2012-06-04T12:34:09Z

Poltawski:

Prior to Moodle 2.3, Google Docs and Picasa repository plugins and portfolio plugins could be used without any configuration or registration with Google. In April 2012, [http://googledevelopers.blogspot.com.au/2012/04/changes-to-deprecation-policies-and-api.html Google Announced] to web application developers that they would be deprecated the service which Moodle was using to communicate with Google and strongly advised developers to move away from it. As a response to this change with Google's service, Moodle switched to use a new system for communicating with Google called 'OAuth 2.0', starting with Moodle 2.3. The OAuth 2.0 system providers and a better security system and more friendly experience to Moodle users, though it requires some additional configuration in Moodle.

==Registering with Google==
Each Moodle site now needs to be registered with Google in order to use the Google Docs or Picasa plugins. The following will guide you through the process of registering with Google.

# You will need to be signed into a google account
# Visit the [Google API's Console https://code.google.com/apis/console#access]
# You will be asked to create a project if this is your first time using this form. [[File:google_oauth1.png]]
# You need to click the button marked 'Create an OAuth 2.0 client ID..' [[File:google_oauth2.png]]
# You will be asked to enter branding information including a 'Product name' and 'Product logo'. By providing a descriptive name and link to distinct image then your users will know they are signing into the correct place. [[File:google_oauth3.png]]
# Next you will be asked for 'Client ID Settings'
## For Application type, select 'Web application'
## Next to 'Your site or hostname' click '(more options)'
## In 'Authorized Redirect URIs' enter the URL which was provided in your Moodle settings page. (usually http://yourmoodle/admin/oauth2callback.php)
## In 'Authorized JavaScript Origins' leave the field blank [[File:google_oauth4.png]]
# Click 'Create client ID'
# Your site is now registered with Google and you will be presented with your details. [[File:google_oauth5.png]]
# Enter the 'Client ID' and 'Client secret' provided into your Moodle settings page

Google OAuth 2.0 setup

2012-06-04T12:33:41Z

Poltawski:

Prior to Moodle 2.3, Google Docs and Picasa repository plugins and portfolio plugins could be used without any configuration or registration with Google. In April 2012, [http://googledevelopers.blogspot.com.au/2012/04/changes-to-deprecation-policies-and-api.html Google Announced] to web application developers that they would be deprecated the service which Moodle was using to communicate with Google and strongly advised developers to move away from it. As a response to this change with Google's service, Moodle switched to use a new system for communicating with Google called 'OAuth 2.0', starting with Moodle 2.3. The OAuth 2.0 system providers and a better security system and more friendly experience to Moodle users, though it requires some additional configuration in Moodle.

==Registering with Google==
Each Moodle site now needs to be registered with Google in order to use the Google Docs or Picasa plugins. The following will guide you through the process of registering with Google.

# You will need to be signed into a google account
# Visit the [Google API's Console https://code.google.com/apis/console#access]
# You will be asked to create a project if this is your first time using this form. [[File:google_oauth1.png]]
# You need to click the button marked 'Create an OAuth 2.0 client ID..' [[File:google_oauth2.png]]
# You will be asked to enter branding information including a 'Product name' and 'Product logo'. By providing a descriptive name and link to distinct image then your users will know they are signing into the correct place. [[File:google_oauth3.png]
# Next you will be asked for 'Client ID Settings'
## For Application type, select 'Web application'
## Next to 'Your site or hostname' click '(more options)'
## In 'Authorized Redirect URIs' enter the URL which was provided in your Moodle settings page. (usually http://yourmoodle/admin/oauth2callback.php)
## In 'Authorized JavaScript Origins' leave the field blank [[File:google_oauth4.png]
# Click 'Create client ID'
# Your site is now registered with Google and you will be presented with your details. [[File:google_oauth5.png]
# Enter the 'Client ID' and 'Client secret' provided into your Moodle settings page

File:google oauth5.png

2012-06-04T12:32:05Z

Poltawski:

File:google oauth4.png

2012-06-04T12:31:43Z

Poltawski:

File:google oauth3.png

2012-06-04T12:31:12Z

Poltawski:

File:google oauth2.png

2012-06-04T12:30:56Z

Poltawski:

File:google oauth1.png

2012-06-04T12:30:33Z

Poltawski:

Google OAuth 2.0 setup

2012-06-04T12:21:21Z

Poltawski: First draft of oauth2 settings This is a difficult page to write because it implicitly contains jargon.

Prior to Moodle 2.3, Google Docs and Picasa repository plugins and portfolio plugins could be used without any configuration or registration with Google. In April 2012, [http://googledevelopers.blogspot.com.au/2012/04/changes-to-deprecation-policies-and-api.html Google Announced] to web application developers that they would be deprecated the service which Moodle was using to communicate with Google and strongly advised developers to move away from it. As a response to this change with Google's service, Moodle switched to use a new system for communicating with Google called 'OAuth 2.0', starting with Moodle 2.3. The OAuth 2.0 system providers and a better security system and more friendly experience to Moodle users, though it requires some additional configuration in Moodle.

==Registering with Google==
Each Moodle site now needs to be registered with Google in order to use the Google Docs or Picasa plugins. The following will guide you through the process of registering with Google.

# You will need to be signed into a google account
# Visit the [Google API's Console https://code.google.com/apis/console#access]
# You will be asked to create a project if this is your first time using this form.
# You need to click the button marked 'Create an OAuth 2.0 client ID..'
# You will be asked to enter branding information including a 'Product name' and 'Product logo'. By providing a descriptive name and link to distinct image then your users will know they are signing into the correct place.
# Next you will be asked for 'Client ID Settings'
## For Application type, select 'Web application'
## Next to 'Your site or hostname' click '(more options)'
## In 'Authorized Redirect URIs' enter the URL which was provided in your Moodle settings page. (usually http://yourmoodle/admin/oauth2callback.php)
## In 'Authorized JavaScript Origins' leave the field blank
# Click 'Create client ID'
# Your site is now registered with Google and you will be presented with your details.
# Enter the 'Client ID' and 'Client secret' provided into your Moodle settings page