MoodleDocs - User contributions [en]

LDAP authentication

2019-11-09T08:51:12Z

Tmuras:

{{Authentication}}
This document describes how to set up Lightweight Directory Access Protocol (LDAP) authentication in Moodle. We cover the basic, advanced and some trouble shooting sections to assist the user in the installation and administrating LDAP in Moodle.

==Basic Scenario==
The simple and straightforward approach for most installations.

===Assumptions===
Moodle supports several types of LDAP servers which have different directory structures, special configuration settings, etc. Even if using the same LDAP server type (e.g., MS Active Directory), each site could use a completely different directory structure to hold its user accounts, groups, etc. In order to be able to show example configuration settings in the sections below, we are going to assume a '''hypothetical''' Moodle site and LDAP server with the characteristics listed below.

'''IMPORTANTE NOTICE''': be sure to check '''''your''''' Moodle site and LDAP server details (including its directory structure,) and adjust the settings to reflect your own setup.

# Your Moodle site is located at '''http://your.moodle.site/'''
# You have configured your PHP installation with the LDAP extension. It is loaded and activated, and it shows when you go to '''http://your.moodle.site/admin/phpinfo.php''' (logged in as user 'admin').
# Your LDAP server has '''192.168.1.100''' as its IP address.
# You are not using LDAP with SSL (also known as LDAPS) in your settings. This might prevent certain operations from working (e.g., you cannot update data if you are using MS Active Directory -- MS-AD from here on --), but should be OK if you just want to authenticate your users.
# You don't want your users to change their passwords the first time they log in into Moodle.
# You are using a single domain as the source of your authentication data in case you are using MS-AD (more on this in the Appendices).
# You are using a top level distinguished name (DN) of '''dc=my,dc=organization,dc=domain''' as the root of your LDAP tree.
# You have a non-privileged LDAP user account you will use to bind to the LDAP server. This is not necessary with certain LDAP servers, but MS-AD requires this and it won't hurt if you use it even if your LDAP server doesn't need it. Make sure '''this account and its password don't expire''', and make this password as strong as possible. Remember you only need to type this password once, when configuring Moodle, so don't be afraid of making it as hard to guess as possible. Let's say this user account has a DN of '''cn=ldap-user,dc=my,dc=organization,dc=domain''', and password '''hardtoguesspassword'''.
# All of your Moodle users are in an organizational unit (OU) called '''moodleusers''', which is right under your LDAP root. That OU has a DN of '''ou=moodleusers,dc=my,dc=organization,dc=domain'''.
# You '''don't''' want your LDAP users' passwords to be stored in Moodle at all.

===Enabling LDAP authentication===

An administrator can enable LDAP authentication as follows:

# Go to ''Site administration > Plugins > Authentication > Manage authentication'' and click the eye icon opposite LDAP Server. When enabled, it will no longer be greyed out.
# Click the settings link, configure as required (see information below), then click the 'Save changes' button.

[[Image:LDAPserversettings.png|center]]

Now, you just have to fill in the values. Let's go step by step.

====LDAP Server Settings====
{| border="1" cellspacing="0" cellpadding="5"
! Field name
! Value to fill in
|-
| Host URL
| As the IP of your LDAP server is 192.168.1.100, type "'''ldap://192.168.1.100'''" (without the quotes), or just "'''192.168.1.100'''" (some people have trouble connecting with the first syntax, specially on MS Windows servers).
|-
| Version
| Unless you are using a really old LDAP server, '''version 3''' is the one you should choose.
|-
| LDAP Encoding
| Specify encoding used by LDAP server. Most probably utf-8.
|}

[[LDAP_authentication#Table of Contents|Table of Contents]]

====Bind settings====
{| border="1" cellspacing="0" cellpadding="5"
! Field name
! Value to fill in
|-
| Don't cache passwords
| As you '''don't''' want to store the users's password in Moodle's database, choose '''Yes''' here.
|-
| Distinguished Name
| This is the distinguished name of the bind user defined above. Just type "'''cn=ldap-user,dc=my,dc=organization,dc=domain'''" (without the quotes).
|-
| Password
| This is the bind user password defined above. Type "'''hardtoguesspassword'''" (without the quotes).
|}

[[LDAP_authentication#Table of Contents|Table of Contents]]

====User lookup settings====
{| border="1" cellspacing="0" cellpadding="5"
! Field name
! Value to fill in
|-
| User type
| Choose:
* '''Novel Edirectory''' if your LDAP server is running Novell's eDdirectory.
* '''posixAccount (rfc2307)''' if your LDAP server is running a RFC-2307 compatible LDAP server (choose this is your server is running OpenLDAP, including Mac OS X server).
* '''posixAccount (rfc2307bis)''' if your LDAP server is running a RFC-2307bis compatible LDAP server.
* '''sambaSamAccount (v.3.0.7)''' if your LDAP server is running with SAMBA's 3.x LDAP schema extension and you want to use it.
* '''MS ActiveDirectory''' if your LDAP server is running Microsoft's Active Directory (MS-AD)
|-
| Contexts
| The DN of the context (container) where all of your Moodle users are found. Type '''ou=moodleusers,dc=my,dc=organization,dc=domain''' here.

On a Mac OS X Server, this is usually '''cn=users,dc=my,dc=organization,dc=domain'''.
|-
| Search subcontexts
| If you have any sub organizational units (subcontexts) hanging from '''ou=moodleusers,dc=my,dc=organization,dc=domain''' and you want Moodle to search there too, set this to '''yes'''. Otherwise, set this to '''no'''.
|-
| Dereference aliases
| Sometimes your LDAP server will tell you that the real value you are searching for is in fact in another part of the LDAP tree (this is called an alias). If you want Moodle to 'dereference' the alias and fetch the real value from the original location, set this to '''yes'''. If you don't want Moodle to dereference it, set this to '''no'''. If you are using MS-AD, set this to '''no'''.
|-
| User attribute
| The attribute used to name/search users in your LDAP tree. This option takes a default value based on the ''User type'' value you chose above. So unless you need something special, you don't need to fill this in.

By the way, it's usually '''cn''' (Novell eDirectory and MS-AD) or '''uid''' (RFC-2037, RFC-2037bis and SAMBA 3.x LDAP extension), but if you are using MS-AD you could (and have to, if you intend to use NTLM SSO) use '''sAMAccountName''' (the pre-Windows 2000 logon account name) if you need too.

'''Correction''': With MS-AD '''sAMAccountName''' should be used anyway. With default value ('''cn''') AD users will have to login with full name / password (Username: '''John Doe''', Password: '''john's_pass'''). If you want to enable your users to login with domain username instead (Username: '''johnd''' Password: '''john's_pass'''), you should use '''sAMAccountName'''. Sadly, but logging in with DOMAIN\user or user@domain.com will not work anyway.

Note: You may wish to consider allowing extended characters in usernames in ''Administration > Site administration > Security > [[Site policies]]''.
|-
| Member attribute
| The attribute used to list the members of a given group. This option takes a default value based on the ''User type'' value you choosed above. So unless you need something special, you don't need to fill this in.

By the way, the usual values are '''member''' and '''memberUid'''.
|-
| Member attribute uses dn
| Whether the member attribute contains distinguished names (1) or not (0).This option takes a default value based on the ''User type'' value you choosed above. So unless you need something special, you don't need to fill this in.
|-
| Object class
| The type of LDAP object used to search for users. This option takes a default value based on the ''User type'' value you chose above. So unless you need something special, you don't need to fill this in.
* If you leave it blank, the default value based on the ''User type'' selected above will be used (see below)
* If you provide "objectClass=some-string", then it will provide "(objectClass=some-string)" as the filter.
* If you provide a value that does not start with "(", it is assumed to be a value that should be set to "objectClass". So if you provide "some-string", then it will provide "(objectClass=some-string)" as the filter.
* If you provide a string that starts with a "(", then it will pass that as is. So if you provide "(&(objectClass=user)(enabledMoodleUser=1))", then it will pass that as the filter.

'''Note''': In the last case, that feature can be used on interactive logins,

Here are the default values for each of the ''ldap_user_type'' values:
* '''(objectClass=user)''' for Novel eDirectory
* '''(objectClass=posixAccount)''' for RFC-2037 and RFC-2037bis
* '''(objectClass=sambaSamAccount)''' for SAMBA 3.0.x LDAP extension
* '''(objectClass=user)''' for MS-AD
* '''(objectClass=*)''' for Default
If you get an error about a problem with updating the ldap server (even if you have specified not to write changes back to the ldap server) try setting the ldap object class to * - see http://moodle.org/mod/forum/discuss.php?d=70566 for a discussion on this problem
|}

====Force change password====
{| border="1" cellspacing="0" cellpadding="5"
! Field name
! Value to fill in
|-
| Force change password
| '''NOTE: This setting is only used when creating your users with the LDAP sync users task. It's not used if your users are created as part of their first login to moodle'''.

Set this to ''Yes'' if you want to force your users to change their password on the first login into Moodle. Otherwise, set this to ''no''. Bear in mind the password they are forced to change is the one stored in your LDAP server.

As you don't want your users to change their passwords in their first login, leave this set to ''No''
|-
| Use standard Change Password Page
|
* Setting this to ''Yes'' makes Moodle use its own standard password change page, everytime users want to change their passwords.
* Setting this to ''No'' makes Moodle use the the page specified in the field called "Password change URL" (see below).

Bear in mind that changing your LDAP passwords from Moodle might require a LDAPS connection (this is actually a requirement for MS-AD). In addition to that, the bind user specified above must have the rights needed to change other users' passwords.

Also, code for changing passwords from Moodle for anything but Novell eDirectory and Active Directory is almost not tested, so this may or may not work for other LDAP servers.
|-
| Password Format
| Specify how the new password is encrypted before sending it to the LDAP server: Plain text, MD5 hash or SHA-1 hash. MS-AD uses plain text, for example.
|-
| Password change URL
| Here you can specify a location at which your users can recover or change their username/password if they've forgotten it. This will be provided to users as a button on the login page and their user page. if you leave this blank the button will not be printed.
|}

====LDAP password expiration settings====
{| border="1" cellspacing="0" cellpadding="5"
! Field name
! Value to fill in
|-
| Expiration
|
* Setting this to ''No'' will make Moodle not to check if the password of the user has expired or not.
* Setting this to ''LDAP'' will make Moodle check if the LDAP password of the user has expired or not, and warn them a number of days before the password expires. When the password has expired, a "Your password has expired" message is displayed, and if the user is able to change their password from Moodle, they are offered the option to do so.

Current code only deals with Novell eDirectory LDAP server and MS-AD.

So unless you have Novell eDirectory server or MS-AD, choose ''No'' here.
|-
| Expiration warning
| This value sets how many days in advance of password expiration the user is warned that her password is about to expire.
|-
| Expiration attribute.
| The LDAP user attribute used to check password expiration. This option takes a default value based on the ''User type'' value you chose above. So unless you need something special, you don't need to fill this in.
|-
| Grace logins
| This setting is specific to Novell eDirectory. If set to ''Yes'', enable LDAP gracelogin support. After password has expired the user can login until gracelogin count is 0.

So unless you have Novell eDirectory server and want to allow gracelogin support, choose ''No'' here.
|-
| Grace login attribute
| This setting is currently not used in the code (and is specific to Novell eDirectory).

So you don't need to fill this in.
|}

====Enable user creation====
{| border="1" cellspacing="0" cellpadding="5"
! Field name
! Value to fill in
|-
| Create users externally
| New (anonymous) users can self-create user accounts on the external LDAP server and confirm them via email. If you enable this, remember to also configure module-specific options for user creation and to fill in some instructions in ''auth_instructions'' field in ''Site administration > Plugins > Authentication > Manage authentication''. Otherwise the new users won't be able to self-create new accounts.

Novell eDirectory and MS-AD can create users externally. You can also create users in RFC-2307 compliant servers.
|-
| Context for new users
| Specify the context where users are created. This context should be different from other users' contexts to prevent security issues.
|}

====Assign system roles====
{| border="1" cellspacing="0" cellpadding="5"
! Field name
! Value to fill in
|-
| System role mapping
| This section lists all roles that have can be assigned in the System context - by default this will be "Manager context" and "Course creator context", but can be customisable in the [[Creating custom roles|role definitions]].

To assign LDAP users to any of the roles, specify the DN containing all users who should be granted that role at the system level.

Thie DN is typically a posixGroup with a "memberUid" attribute for each user you want to be a creator. If your group is called ''creators'', type '''cn=creators,ou=moodleusers,dc=my,dc=organization,dc=domain''' here. Each memberUid attribute contains the CN of a user who is authorized to be a creator. Do not use the user's full DN (e.g., not '''memberUid: cn=JoeTeacher,ou=moodleusers,dc-my,dc=organizations,dc=domain''', but rather '''memberUid: JoeTeacher''').

In eDirectory, the objectClass for a group is (by default) not '''posixGroup''' but '''groupOfNames,''' whose member attribute is '''member,''' not '''memberUid,''' and whose value is the full DN of the user in question. Although you can probably modify Moodle's code to use this field, a better solution is just to add a new '''objectClass''' attribute of '''posixGroup''' to your creators group and put the CNs for each creator in a '''memberUid''' attribute.

In MS Active Directory, you will need to create a security group for your creators to be part of and then add them all. If your ldap context above is 'ou=staff,dc=my,dc=org' then your group should then be 'cn=creators,ou=staff,dc=my,dc=org'. If some of the users are from other contexts and have been added to the same security group, you'll have to add these as separate contexts after the first one using the same format.

This section replaces the "Course creator" section found in Moodle 3.3. The upgrade process should migrate any DN specified to the new approach.

|}

====User account synchronisation====
{| border="1" cellspacing="0" cellpadding="5"
! Field name
! Value to fill in
|-
| Removed ext user
| Specify what to do with internal user account during mass synchronization when user was removed from external source. Only suspended users are automatically revived if they reappear in ext source.
|}

====NTLM SSO====
{| border="1" cellspacing="0" cellpadding="5"
! Field name
! Value to fill in
|-
| Enable
| If you want to use NTLM SSO (see details at [[NTLM_authentication]]), choose ''Yes'' here. Otherwise, choose ''No''.
|-
| Subnet
| Specify the subnets of the clients that will use NTLM SSO (see details at [[NTLM_authentication]]).
|-
| MS IE Fast Path?
| If all of you clients (or most of them) are using MS Internet Explorer, you can set this option to bypasses certain steps of the SSO login and speed up login times. This only works with MS Internet Explorer, but deals with other browsers in a sensible way (they are automatically sent to the plain login page).
|}

====Data Mapping====
{| border="1" cellspacing="0" cellpadding="5"
! Field name
! Value to fill in
|-
| First name
| The name of the attribute that holds the first name of your users in your LDAP server. This is usually '''givenName''' or '''displayName'''

This setting is optional
|-
| Surname
| The name of the attribute that holds the surname of your users in your LDAP server. This is usually '''sn'''.

This setting is optional
|-
| Email address
| The name of the attribute that holds the email address of your users in your LDAP server. This is usually '''mail'''.

This setting is optional
|-
| City/town
| The name of the attribute that holds the city/town of your users in your LDAP server. This is usully '''l''' (lowercase L) or '''localityName''' (not valid in MS-AD).

This setting is optional
|-
| Country
| The name of the attribute that holds the country of your users in your LDAP server. This is usully '''c''' or '''countryName''' (not valid in MS-AD).

This setting is optional
|-
| Language
| '''preferredLanguage'''

This setting is optional
|-
| Description
| '''description'''

This setting is optional
|-
| Webpage
| This setting is optional
|-
| ID Number
|

This setting is optional
|-
| Institution
|

This setting is optional
|-
| Department
| The name of the attribute that holds the department name of your users in your LDAP server. This is usully '''departmentNumber''' (for posixAccount and maybe eDirectory) or '''department''' (for MS-AD).

This setting is optional
|-
| Phone 1
| The name of the attribute that holds the telephone number of your users in your LDAP server. This is usually '''telephoneNumber'''.

This setting is optional
|-
| Phone 2
| The name of the attribute that holds an additional telephone number of your users in your LDAP server. This can be '''homePhone''', '''mobile''', '''pager''', '''facsimileTelephoneNumber''' or even others.

This setting is optional
|-
| Address
| The name of the attribute that holds the street address of your users in your LDAP server. This is usully '''streetAddress''' or '''street'.

This setting is optional
|}

=====Custom User profile fields=====

Any user profile fields created in ''Site administration > Users > Accounts > User profile fields'' should now automatically show up at the end of the Data mapping field list after the '''Address''' field. See example: [[File:ldapcustomuserprofilefields.jpg]]

==Enabling the LDAP users sync job==

The LDAP users sync job (''\auth_ldap\task\sync_task'') [[Scheduled tasks|scheduled task]] (new in Moodle 3.0; previously there was a CLI script, see MDL-51824 for more info) is responsible for creating and updating user information, and suspending and deleting LDAP accounts.

After enabling LDAP server authentication, an administrator needs to enable and configure the LDAP users sync job as follows:

# Go to ''Site administration > Server > Scheduled tasks'' and click the gear icon opposite LDAP users sync job.
# Select the desired frequency of running and enable the task by un-ticking the disabled checkbox.
{{Warning|It is important to make sure that all LDAP settings are working properly before enabling the LDAP users sync job (as well as backing up your database and moodledata folders), since incorrect LDAP configuration can result in users being wrongly deleted!}}

If you find that the script is not running through all of your users properly and you have over 1000 users in each LDAP container, this is because by default some LDAP stores such as MS AD only send back 1000 users at a time and PHP versions prior to 5.4 did not implement paged support for LDAP results. If you upgrade to PHP 5.4 or higher then Moodle will obtain all your users correctly. If you can't upgrade to PHP 5.4 you may be able to follow the instructions in http://support.microsoft.com/kb/315071 to set the Active Directory MaxPageSize setting to a number higher than your total number of users (both now and in future) to fix it. This is a forest-wide setting.

==Active Directory help==
[[Active Directory]] is Microsoft's directory service. It is included in Windows 2000 Server and later versions of their operating system. For more information about subjects below, '''[[Active Directory|please go here]]'''.

*Warning: The PHP LDAP module does not seem to be present
*LDAP-module cannot connect any LDAP servers
*Getting correct CNs for Contexts and Creators
*Getting the right user_attribute
*Installing ldp.exe Server Tool
*Example Active Directory Configuration
*Child Domains and the Global Catalog in MS Active Directory
*Enabling the Global Catalog
*Active Directory with Moodle 1.8
*MS Active Directory + SSL

==Advanced Scenarios - Multiple servers or locations==
For larger installations with multiple LDAP servers, or multiple locations (contexts) in a LDAP tree.

===Making your LDAP directory connection resilient===
* Entering more than one name in the ldap_host_url field can provide some sort of resilience to your system. Simply use the syntax:

ldap://my.first.server; ldap://my.second.server; ...

Of course, this will only work if all the servers share the same directory information, if using eDirectory you would need to ensure your servers have viability of all relevant tree partitions, or if using Active Directory the servers are holding the same information you need though replication - see notes on a multi-domain environment if this applies.

There is one drawback in Moodle 1.5 - 1.6 implementation of LDAP authentication : the auth_ldap_connect() function processes the servers sequentially, not in a round robin mode. Thus, if the primary server fails, you will have to wait for the connection to time out before switching to the following one.

See also: [http://moodle.org/mod/forum/discuss.php?d=17198 Using multiple LDAP servers - Our students are on separate domain] forum discussion

===Using a multi-domain AD environment===
* If you're running Active Directory with multiple domains and you have users in more then one domain you will want to configure Moodle to look at your Global Catalog server. Specifically your top level domain Global Catalog server. Here is a simple example of this kind of Active Directory layout:

my.domain.ca (Root AD Domain)
| - dc1.my.domain.ca (Domain Controller)
| - dc2.my.domain.ca (Domain Controller)
|
| - - students.my.domain.ca (Sub AD Domain)
| - - - dc1.students.my.domain.ca (Domain Controller)
| - - - dc2.students.my.domain.ca (Domain Controller)
|
| - - faculty.my.domain.ca (Sub AD Domain)
| - - - dc1.faculty.my.domain.ca (Domain Controller)
| - - - dc2.faculty.my.domain.ca (Domain Controller)

In this example we have our top level domain (my.domain.ca) and two sub-domains. One sub-domain is for faculty accounts (faculty.my.domain.ca) and the other is for student accounts (students.my.domain.ca). Listed under each of those are two domain controllers.

Using the above example you'll want to use the following for accessing the Global Catalog over SSL:

ldaps://my.domain.ca:3269/

If you prefer to access your global catalog over a non-SSL connection you'll want to use:

ldap://my.domain.ca:3268/

We found if you didn't configure things this way you'd get errors like:

[Thu May 26 15:23:53 2011] [error] [client 192.168.xxx.xxx] PHP Warning: ldap_search() [<a href='function.ldap-search'>function.ldap-search</a>]: Search: Partial results and referral received in /xxx/xxx/moodle20/lib/ldaplib.php on line 241, referer: http://moodle.my.domain.ca/moodle20/login/index.php
[Thu May 26 15:23:53 2011] [error] [client 192.168.xxx.xxx] PHP Warning: ldap_first_entry(): supplied argument is not a valid ldap result resource in /xxx/xxx/moodle20/lib/ldaplib.php on line 248, referer: http://moodle.my.domain.ca/moodle20/login/index.php

===Using multiple user locations (contexts) in your LDAP tree===
There is no need to use multiple user locations if your directory tree is flat, i.e. if all user accounts reside in a '''ou=people,dc=my,dc=organization,dc=domain''' or '''ou=people,o=myorg''' container.

At the opposite, if you use the ACL mecanism to delegate user management, there are chances that your users will be stored in containers like '''ou=students,ou=dept1,o=myorg''' and '''ou=students,ou=dept2,o=myorg''' ...

Then there is an alternative :
* Look at the '''o=myorg''' level with the ldap_search_sub attribute set to '''yes'''.
* Set the ldap_context to '''ou=students,ou=dept1,o=myorg ; ou=students,ou=dept2,o=myorg'''.

Choosing between these two solutions supposes some sort of benchmarking, as the result depends heavily on the structure of your directory tree '''and''' on your LDAP software indexing capabilities. Simply note that there is a probability in such deep trees that two users share the same ''common name'' (cn), while having different ''distinguished names''. Then only the second solution will have a deterministic result (returning allways the same user).

===Using LDAPS (LDAP over SSL)===
====Enabling LDAPS on your directory server====

* [[Active_Directory#MS_Active_Directory_.2B_SSL|Enabling LDAPS on MS Active Directory ]]

====Enabling LDAPS on your Moodle server====
Enabling LDAPS on your server can be tricky and often it is hard to pinpoint where things are going wrong. There are also differences between Windows and Linux and even different versions and distributions of Linux.

'''If you have not done so already you will need to decide upon your approach to establishing an SSL connection to your directory server:'''

* SSL connection with unverified self-signed certificate.

You can generate your own SSL certificate, and then instruct your Moodle server to ignore the fact that it is not valid. This setup is not as secure as others since you cannot be sure the server you are connecting to is not fake.

* SSL connection with trusted self-signed certificate.

You can generate your own SSL certificate on your directory server, and then specifically trust this certificate by installing it on your Moodle server.

* SSL connection with verified certificate from Internet-trusted certificate authority (CA)

In this approach the LDAP server has an installed certificate from an Internet-based CA, this means that your directory server would have an Internet address & host name. Your Moodle server must be trusting the certificate authority and have Internet access. This approach is not often used as it usually incurs a cost for the certificate, and it requires your directory server and Moodle server to be exposed to the Internet.

==Linux servers==
'''These instructions are for establishing a link using a trusted self-signed certificate.'''

''Note: written for a Red Hat Enterprise Linux 6 server, other Linux distributions may differ, especially in the location of the SSL certificates and OpenLdap config files, but the core principals are the same.''

To check that your directory server is online and accepting SSL connections on your LDAPS port (636), you can use try:
openssl s_client –connect <ldap server ip address>:636

Get your directory server’s certificate (.crt) and upload to Moodle server's ssl certificate directory, on RHEL6 this is at '''/etc/ssl/certs'''

Convert your ‘DER’ X509 certificate into a ‘PEM’ public key certificate.
openssl x509 -in my_server_certificate.cer -inform DER -out my_server_certificate.pem -outform PEM

Create certificate hashes using c_rehash
c_rehash
''If c_rehash is not installed install with: yum install /usr/bin/c_rehash''

Ensure you are able to access your LDAPS server by a DNS name, this may mean adding an entry to your host file (/etc/hosts)
<ldap server ip address> my_server.mydomain.school

Verify your certificate to check that it is installed correctly
openssl verify -verbose -CApath /etc/ssl/certs /etc/ssl/certs/my_server_certificate.pem
/etc/ssl/certs/my_server_certificate.pem: OK

You should now be able to connect to your LDAPS server over SSL without any errors
openssl s_client –connect <ldap server DNS name>:636

Edit your OpenLDAP config, on RHEL6 this is located at '''/etc/openldap/ldap.conf'''
# Define location of a CA Cert
TLS_CACERT /etc/ssl/certs/my_server_certificate.pem
TLS_CACERTDIR /etc/ssl/certs

Finally, you may or may not need to restart Apache, before configuring Moodle to use ldaps://<server DNS name>
httpd -k restart

==Windows servers==
'''These instructions are for establishing a link using an unverified self-signed certificate.'''

You can tell PHP's OpenLDAP extension to disable SSL server certificate checking to do this you must create a directory called ''''C:\OpenLDAP\sysconf\'''' In this directory, create a file called ''ldap.conf'' with the following content:

TLS_REQCERT never

''(If you are using certain versions of PHP 5.3.x you '''may need to place the file at other locations''', [http://bugs.php.net/bug.php?id=48866 see PHP bug #48866])''

Now you should be able to use '''ldaps://''' when connecting to your LDAP server.

==Appendices==

=== Setting Resource Limits RedHat Directory Server ===

Operational attributes can be set for the bind user DN using the command-line.
One can simply use ldapmodify to add the following attributes:

{| border="1" cellspacing="0" cellpadding="5"
! Attribute Name
! Description
|-
| nsLookThroughLimit
| Specifies how many entries are examined for a search operation. Giving this attribute a value of -1 indicates that there is no limit.
|-
| nsSizeLimit
| Specifies the maximum number of entries the server returns to a client application in response to a search operation. Giving this attribute a value of -1 indicates that there is no limit.
|-
| nsTimeLimit
| Specifies the maximum time the server spends processing a search operation. Giving this attribute a value of -1 indicates that there is no time limit.
|-
| nsIdleTimeout
| Specifies the time a connection to the server can be idle before the connection is dropped. The value is given in seconds. Giving this attribute a value of -1 indicates that there is no limit.
|}

<pre> LDAP Console Command-Line

ldapmodify -h redhat_dir_server -p 389 -D "cn=directory manager" -w secretpwd

dn: uid=MoodleAdmin,ou=system,dc=myschool,dc=edu
changetype: modify
add:nsSizeLimit
nsSizeLimit: 1000
</pre>

==Any questions?==

Please post in the [http://moodle.org/mod/forum/view.php?id=42 Authentication forum] on moodle.org.

==See also==

* [[NTLM_authentication]]
* [[Active_Directory]]
* [[LDAP enrolment]]
* [http://download.moodle.org/download.php/docs/en/how-to_guides/ldap_auth_and_enrolment_set-up.pdf LDAP auth and enrolment set-up guide] (PDF 227KB)

Forum discussions:
* [http://moodle.org/mod/forum/view.php?id=42 User authentication forum]
* [http://moodle.org/mod/forum/discuss.php?d=32168 PHP LDAP module does not seem to be present] forum discussion
* [http://moodle.org/mod/forum/discuss.php?d=140901 Syncronisation with AUTH_LDAP_SYNC_USERS.PHP produces fewer accounts than it should] forum discussion
* [http://moodle.org/mod/forum/discuss.php?d=17198 Using multiple LDAP servers] forum discussion

[[es:LDAP_authentication]]
[[fr:Utiliser un serveur LDAP]]
[[ja:LDAP認証]]
[[de:LDAP-Server]]

Talk:Redis cache store

2019-09-16T14:09:25Z

Tmuras:

"If you are configuring a cluster of Moodle servers/nodes, the [[Redis]] service (daemon) should be installed on an external server and all Moodle nodes (servers/instances) should point to that external Redis. so all user's data is available when the user is using (connected to) any of the Moodle nodes, '''in case the user's connection is not persistent (sticky) to a specific node for the entire Moodle session'''."

This bit is not really correct, unless you meant only session cache:
in case the user's connection is not persistent (sticky) to a specific node for the entire Moodle session

Talk:Redis cache store

2019-09-16T14:07:49Z

Tmuras:

"If you are configuring a cluster of Moodle servers/nodes, the [[Redis]] service (daemon) should be installed on an external server and all Moodle nodes (servers/instances) should point to that external Redis. so all user's data is available when the user is using (connected to) any of the Moodle nodes, in case the user's connection is not persistent (sticky) to a specific node for the entire Moodle session."

This bit is not really correct, unless you meant only session cache:
in case the user's connection is not persistent (sticky) to a specific node for the entire Moodle session

Redis cache store

2019-09-16T14:07:33Z

Tmuras:

{{Performance}}
The Redis cache store is one of the best options to handle session and application cache as it supports: data guarantee, locking, key awareness. (and also can be used for [[Session_handling#Redis_session_driver|user's sessions caching]] in the config.php file)

Before Redis is available as a cache store, you will need to install [[Redis]] service (daemon) on your Moodle server, locally in case of a single Moodle app node architecture or externally if you are using a cluster of Moodle nodes. only then, you can configure Redis as an application or session level cache store.

If you are configuring a cluster of Moodle servers/nodes, the [[Redis]] service (daemon) should be installed on an external server and all Moodle nodes (servers/instances) should point to that external Redis. So all user's data is available when the user is using (connected to) any of the Moodle nodes. An external Redis (NoSQL) service can be installed on the main SQL server alongside the MySQL/MariaDB service, just make sure you have enough memory allocated on that server for both services.

A good practice is to give the [[Redis]] cache store prefix a proper short name and not leave it empty, as later on, it might conflict with user's session Redis cache you might choose to use, or other Moodle instances that will be installed on the same server. for example "my-school-name_cs_", where you replace "my-school-name" with your short school name. (and if you are also using a user's session store on the config.php file, you might like to prefix it with "my-school-name_us_")

When using a cluster setup with several Moodle instances on each node that belong to different Schools/Institutes/clients, make sure that you use the same Prefix for all Moodle instances that are on different nodes and are of the same School/Institute/Client.

==Installing Redis server==
* [https://www.linode.com/docs/databases/redis/install-and-configure-redis-on-centos-7 install and configure redis on centos 7]
* [https://www.digitalocean.com/community/tutorials/how-to-install-and-secure-redis-on-ubuntu-18-04 install and configure redis on Ubuntu 18.04]
* [[Session_handling#Redis_session_driver]] and [https://www.digitalocean.com/community/tutorials/how-to-set-up-a-redis-server-as-a-session-handler-for-php-on-ubuntu-14-04 How to Set Up a Redis Server as a Session Handler for PHP]
* Install [https://dl.iuscommunity.org/pub/ius/stable/CentOS/7/x86_64/repoview/redis5.html Redis 5] via IUS CentOS 7 repository.

==Installing Redis php driver==
* For CentOS, you can use either [https://rpms.remirepo.net/ Remi] or [https://ius.io/ IUS] repositories, and install the [https://dl.iuscommunity.org/pub/ius/stable/CentOS/7/x86_64/repoview/php71u-pecl-redis.html php71u-pecl-redis] driver.
* [https://gist.github.com/hollodotme/418e9b7c6ebc358e7fda Redis php-fpm 7 driver on Ubuntu 14.04]

==See also==
* [https://gist.github.com/kabel/10023961 Monitor Redis stats (a php one page app)]
* MDL-48468 : Add a Redis cache store to Moodle core

[[de:Redis Cache]]

Talk:Redis cache store

2019-09-16T14:06:36Z

Tmuras: Created page with "If you are configuring a cluster of Moodle servers/nodes, the Redis service (daemon) should be installed on an external server and all Moodle nodes (servers/instances) sho..."

If you are configuring a cluster of Moodle servers/nodes, the [[Redis]] service (daemon) should be installed on an external server and all Moodle nodes (servers/instances) should point to that external Redis. so all user's data is available when the user is using (connected to) any of the Moodle nodes, in case the user's connection is not persistent (sticky) to a specific node for the entire Moodle session.

This bit is not really correct, unless you meant only session cache:
in case the user's connection is not persistent (sticky) to a specific node for the entire Moodle session

Restrict access FAQ

2019-03-10T09:44:20Z

Tmuras: /* Can I make access to a course conditional upon completing another course? */

{{Restrict access}}
==What IS restrict access?==

Restrict access is a feature that enables a teacher to release resources and activities for their students based on certain criteria such as date, grade received or participation.

==Where are the restrict access settings?==

'Conditional access' needs to be enabled by an administrator in ''Administration > Site administration > Advanced features'' and a teacher will then see "restrict access" options in the set-up screen of each activity.

==Can I make access to a course conditional upon completing another course?==

Not currently, no. It is not possible to restrict access to course B until a student has completed course A. There are workarounds though such as setting a final page at the end of course A which is only revealed once the student has completed course A. In this page you can include the enrolment key for course B. However - this relies on trusting students not to pass the key onto others.

There is one [https://moodle.org/plugins/enrol_coursecompleted additional plugin for Moodle 3.3 and newer] - With this plugin it is possible to create a chain of courses. After completion of a course, the student is automatically enrolled in one or more other courses. But it is also possible to give a user another role in the same course when he/she completes the course.

==Can I restrict access to a whole section, not just individual activities?==

Yes you can. The settings are within each course section when you click the "edit" icon.

==Can I hide an item, reveal it, and then hide it again?==

Yes you can. See this forum post on [https://moodle.org/mod/forum/discuss.php?d=263547 using restrict access to make labels visible and then invisible].

[[Category:FAQ]]

[[de:Voraussetzungen FAQ]]
[[es:Restringir acceso FAQ]]

Groupings

2013-10-12T11:22:29Z

Tmuras: /* Examples of groupings */

{{Grouping users}}

If you want to make an activity (such as an assignment or a quiz) visible to only one set of users within a course, you need first to put the users into a [[Groups|group]] and then put them into a grouping. A single grouping can house one group or several groups.

If you assign an activity to a grouping then only the group/grouping that is selected will be able to see and do the activity. It will be invisible to other groups or groupings.

NOTE: if you want to show resources (such as a folder or webpage) to just to one group and not another, see [[Available for group members only]].

==Adding groups to a grouping==
To add groups to a grouping:
*In your course, click ''Settings > Course administration > Users > Groups''.
*Click the groupings tab:

[[File:Groupingstabs.png]]
*If necessary, create a new grouping by clicking the create grouping button on the groupings page.

An optional grouping ID number (an advanced setting) may be added for matching the grouping against external systems. Grouping ID numbers are not displayed anywhere on the site. Within a course, all grouping ID numbers must be unique. Thus it's not possible to create a grouping with a duplicate grouping ID number.

*Click the "Show groups in grouping" people icon in the edit column:

[[File:Showgroupsingroupings2.png]]

*On the add/remove groups page, select the group(s) you want to add to the grouping from the "Potential members" list.
*Click the arrow button that points towards the "Existing members" list.

[[File:Addremovegroupings.png]]
*Click the "Back to groupings" button. The group(s) you added to the grouping will now be listed in the table on the groupings page.

Existing groupings can be edited and/or deleted using the appropriate icons in the edit column of the table on the groupings page.

==Setting the default grouping==

Once some groupings have been created, a default grouping for course activities and resources may be set.

#Follow the settings link in the course administration block.
#In the groups section in the course settings, select the default grouping.

The default grouping is used on the Participants page.

==Selecting grouping in activity==
To use a particular grouping in an activity:
*In the "edit settings" link of the Settings block for the activity, click the "Show advanced" button in the common module settings section.
*Ensure that the group mode is set to separate or visible groups.
*Select the grouping from the grouping dropdown menu.
*Check the "Available for group members only" box.

[[File:Setyourgrouping.png]]

*Click the "Save changes" button at the bottom of the page.

Students will only see the activities they have been assigned to. Teachers will see the name of the grouping in brackets after the activity name on the course page. A count of activities assigned to each grouping is kept on the groupings page.

Please note that the grouping option appears by default only in activities that support group modes. If you enable ''Available for group members only'' you will be able to assign resources to specific groups also.

==Restricting a whole topic to a grouping==

There is a dropdown setting in each topic summary which allows you to select a particular grouping for that topic section. To enable this setting, you need to enable both [[Conditional activities]] and [[Available for group members only]]

[[File:topicgrouping.gif]]

==Examples of groupings==

It sometimes helps to think of a grouping as a [http://en.memory-alpha.org/wiki/Cloaking_device| Romulan cloaking device] Those groups inside it know of their existence but other groups within the course cannot see them.

===Example 1: Differentiation===

*You have course on Macbeth shared by three teachers. The activities and resources are mostly the same and used by all three classes.
*However, Mr Brown’s class are a higher ability and so are set some extension assignments that must not be seen by Mrs Smith’s class who are of a lower ability. Mrs Smith’s class need some extra assistance and are set some activities which are too easy for Mr Brown's students. Ms Black’s class are middle ability and can cope with some of the higher tasks but also benefit from some of the supportive tasks Mrs Smith uses.

Groupings would allow all three teachers to share the course and yet direct activities to specific classes:

#''3000 word in-depth assignment'' - only for Class Brown. The class is added to the grouping “Class Brown” and the assignment is set to the “Class Brown” grouping. Only these students will see it.
#''Basic Shakespeare vocabulary'' –a page only for Class Smith. The class is added to the grouping “Class Smith” and the page is set to the "Class Smith" grouping (See [[Available for group members only]] for resources) Only the students with special educational needs will see it.
#''Quiz on the main protagonists'' –suitable for Class Brown (high ability) but offered to Class Black also to extend their learning. Both classes are added to a grouping “ClassBrownBlack” and the quiz is set to the "ClassBrownBlack" grouping. These two classes will see the quiz but Mrs Smiths’s will not.

===Example 2: Mandatory and optional modules===

*A university has a mandatory module of work ''FS32'' and two optional modules ''FS33'' and ''FS34'' within a single Moodle course. So all students must complete FS32 and then choose either one of the other two options. Once students have signed up to one of the optional modules they are not allowed to view the contents of the other module.
*Three groups may be made: group FS32 including all students on the course; group FS33 including only those who have signed up for this optional module, and group FS34 including only those who have signed up for the other optional module.
#Nothing needs to be done with the activities in the mandatory module FS32 as all students need to access them. The activities can be set to separate or visible groups but no grouping is necessary.
# In order for only those students who signed up for optional modules FS33 and FS34 to view them, "Group FS33" needs to be put into "Grouping FS33". and "Group FS32" needs to be put into "Grouping FS34"
#. The activities in each of the two optional modules can then be assigned to the respective groupings. With Moodle 2.3 it is possible to allocate whole course sections to groupings so it might be useful to add the activities to a particular course section to save administrative time.

==One way to visualise groupings==
Olympic metaphor: at the Olympics, there are different sports (gymnastics, swimming, track) and many countries. There are two ways to think of an Olympian athlete: by the sport they compete in, and by their nationality. To be part of the United States Olympic Team, you must first be a swimmer, a gymnast, or a runner. You cannot be in the US Team without first being an athlete in a specific sport. The sport is your group. Your country is your grouping. You must belong to a group before joining a grouping.

==See also==

*[[Available for group members only]]
*[[Import groups |Importing users into groupings via CSV]]
*[[Groupings FAQ]]
*Using Moodle [http://moodle.org/mod/forum/discuss.php?d=131905 Moodle Groups vs. Groupings] forum discussion including youtube video showing how to set up groupings

[[fr:Groupements]]
[[ja:グルーピング]]
[[de:Gruppierungen]]
[[ca:Agrupaments]]

Theme settings

2013-04-16T16:34:46Z

Tmuras: /* Change default hierarchy */

{{Themes}}
== Theme settings ==
An administrator can change theme settings in ''Settings > Site administration > Appearance > Themes > Theme settings''.

[[File:Themesettings.png]]

===Theme list===
This lists the themes available for course and user themes. Leave this blank to allow any valid theme to be used. If you want to shorten the theme menu, you may specify a comma-separated list of names, though don't use spaces (e.g. standard,orangewhite).

You can preview the available themes in ''Settings > Site Administration > Appearance > Themes > Themes selector.''

===Theme designer mode===
Turn this on if you are designing and testing themes as it will stop the themes being cached and enable you to see theme changes quickly. (You can also do this with the Clear theme cache button on the theme selector page.)

===Allow user themes===
If the option ''allowuserthemes'' is enabled, each user may select their preferred theme on the edit profile page. All Moodle pages will be displayed in the user's theme, apart from courses where a course theme has been set.

===Allow course themes===
If you enable this, then teachers will be able to set their own course themes. Course themes override all other theme choices (site, user, or session themes).

*If the option ''allowcoursethemes'' is enabled, each editing teacher may select their course theme via the Force theme option on the [[course/edit|Course settings]] page. The course will always be displayed in the theme specified in the course setting, with user and the site themes being overwritten.

===Allow category themes===
When enabled, themes can be set at the category level. This will affect all child categories and courses unless they have specifically set their own theme. WARNING: Enabling category themes may affect performance, as it will result in a few extra DB queries on each page, so only turn this on if you need it!

===Allow theme changes in the URL===
*If this is checked then the theme may be changed by adding <code>?theme=theme_name</code> (or <code>&theme=theme_name</code> if there are other URL parameters) to the URL in the browser. Theme names should be in lower case with spaces replaced by underscores, for example the theme "Formal white" should be entered as <code>?theme=formal_white</code>

===Allow users to hide blocks===
Allows users to display and hide blocks

===Allow blocks to use the docks===
*If the theme allows it, then checking this will allow the user to move blocks to the side dock.

===Custom menu items===
The custommenuitems setting allows you to create a drop down menu that can be displayed by themes that support it. Currently all themes that are provided with Moodle 2.0 support this custom menu.

You are able to create the custom menu by entering custom menu items one per line into the setting. Each item is preceded by a number of hyphens (-), the number of hyphens determines the depth of the item. So items that are '''NOT''' preceded by a hyphen appear on the top level of the menu (always visible), items with a single hyphen appear on a drop down menu below the previous top level item, and items with two hyphens appear on a drop down menu below the previous first level item and so on.

The content of each item is constructed of up to three bits, each separated by a '''|''' (Shift + \) character. The bits are '''label''' | '''url''' | '''tooltip'''.
; label : This is the text that will be shown within the menu item. You must specify a label for every item on the menu.
; url : This is the URL that the user will be taken to it they click the menu item. This is optional, if not provided then the item will not link anywhere.
; tooltip : If you provide a URL you can also choose to provide a tooltip for the link that is created with the URL. This is optional and if not set the label is used as the tooltip for the menu item.

The following is an example of how you would create a custom menu:

<pre>
Moodle community|http://moodle.org
-Moodle free support|http://moodle.org/support
-Moodle development|http://moodle.org/development
--Moodle Tracker|http://tracker.moodle.org
--Moodle Docs|https://docs.moodle.org
-Moodle News|http://moodle.org/news
Moodle company
-Moodle commercial hosting|http://moodle.com/hosting
-Moodle commercial support|http://moodle.com/support
</pre>

Note: The custom menu does not escape characters within the label, if you want to use a special HTML character such as an ampersand you must escape it yourself within the label. e.g. use & instead of &.

For more information on this setting please see the ''Using Moodle'' forum discussion [http://moodle.org/mod/forum/discuss.php?d=149803 Moodle 2.0: Custom menu in core]

==== Multilanguage support ====

You can add a language code (or a comma separated list of codes) as the 4th item of the line. The line will be then printed if and only if the user has currently selected the listed language. For example:

<pre><nowiki>
English only|http://moodle.com|English only item|en
German only|http://moodle.de|Deutsch|de,de_du,de_kids
</nowiki></pre>

==== Adding other attributes to the HTML ====
Other attributes, such as '''target''' can be added with escaped quotes:
<pre><nowiki>
Moodle Homepage|http://moodle.org\" target=\"_blank
</nowiki></pre>
The first escaped quote closes the href attribute, allowing other attributes to be added. All quotes for the extra attributes must be escaped as well. Do not add the closing quotation mark on the final attribute, it is added automatically by Moodle.

===Enable device detection===
Will detect mobile and tablets that identify themselves via the web browser at the time of login to Moodle. These work with the theme selector. When the theme selector has identified a default, mobile and tablet themes, this feature will use that theme.

===Device detection regular expressions===
This will allow you to customize the theme selector options. For example, you can add a custom theme for IE6 and another for Windows CE by entering the identifying expressions the browser sends and the "Return value" you want to display as the theme selectors "Device type".

==Special themes==

=== Session themes ===
Moodle offers an additional way to set a theme - the '''session theme'''. This is set with the URL and lasts until you log out. When you next login, the site/course/user themes are active again. This option is great for theme testing and works perfectly when you want to enable different themes for different situations.

For example you can offer a special link for PDA users and integrate the session theme ''orangewhitepda'' in that link. Nobody needs to change any settings, you just click on that link. The session theme is called by the URL parameter <code>&theme=orangewhitepda</code>. The whole URL without the session theme could look like <code><nowiki>http://mymoodlesite.org/course/view.php?id=18</nowiki></code> and with the parameter for the PDA theme like <code><nowiki>"http://mymoodlesite.org/course/view.php?id=18&theme=orangewhitepda"</nowiki></code>.

In a standard Moodle installation, session themes are not active. To activate them the administrator must add the parameter <code>$CFG->allowthemechangeonurl = true;</code> to the Moodle ''config.php'' file in the Moodle base directory.

=== Page theme ===
A page theme is for special page-only themes set by code, use <code>$PAGE->force_theme()</code>.

== Theme hierarchy ==
Here is the usual order that themes are considered by the Moodle interface.

{| style="border:1px dashed #ddd"
|- style="vertical-align:top;text-align:left"
!Theme type
! style="background:#eee"|Overwrites
!Display
! style="background:#eee"|Setting type
|- style="vertical-align:top"
|Site
|style="background:#eee"| -
|all pages*
|style="background:#eee"|saved in theme profile
|- style="vertical-align:top"
|User
|style="background:#eee"|Site theme
|all pages*
|style="background:#eee"|saved in user profile
|- style="vertical-align:top"
|Course
|style="background:#eee"|Site, user and session themes
|one course
|style="background:#eee"|saved in course profile
|- style="vertical-align:top"
|Session
|style="background:#eee"|Site and user themes
|all pages*
|style="background:#eee"|temporary until logout
|}
(* except courses with the course theme set)

=== Change default hierarchy===
The priority of themes can be set via the /moodle/config.php file. The order defines which theme wins when there are several set at different levels. You can set a variable called $CFG->themeorder (see config-dist.php for more details). By default it is set to:

<code><nowiki>$CFG->themeorder = array('course', 'category', 'session', 'user', 'site');</nowiki></code>

==Particular theme settings==

Logo, tagline, link colour, column width, custom CSS and other settings for a particular theme may be set by an administrator in ''Settings > Site administration > Appearance > Themes > Theme name''.

==See also==

*[http://www.youtube.com/watch?v=mCVsJ3Wsoj8 Video demonstrating how to set a category theme in Moodle 1.9]

[[es:Configuración de temas]]
[[fr:Configuration des thèmes]]
[[ja:テーマ設定]]
[[de:Design-Einstellungen]]

Theme settings

2013-04-16T16:34:14Z

Tmuras:

{{Themes}}
== Theme settings ==
An administrator can change theme settings in ''Settings > Site administration > Appearance > Themes > Theme settings''.

[[File:Themesettings.png]]

===Theme list===
This lists the themes available for course and user themes. Leave this blank to allow any valid theme to be used. If you want to shorten the theme menu, you may specify a comma-separated list of names, though don't use spaces (e.g. standard,orangewhite).

You can preview the available themes in ''Settings > Site Administration > Appearance > Themes > Themes selector.''

===Theme designer mode===
Turn this on if you are designing and testing themes as it will stop the themes being cached and enable you to see theme changes quickly. (You can also do this with the Clear theme cache button on the theme selector page.)

===Allow user themes===
If the option ''allowuserthemes'' is enabled, each user may select their preferred theme on the edit profile page. All Moodle pages will be displayed in the user's theme, apart from courses where a course theme has been set.

===Allow course themes===
If you enable this, then teachers will be able to set their own course themes. Course themes override all other theme choices (site, user, or session themes).

*If the option ''allowcoursethemes'' is enabled, each editing teacher may select their course theme via the Force theme option on the [[course/edit|Course settings]] page. The course will always be displayed in the theme specified in the course setting, with user and the site themes being overwritten.

===Allow category themes===
When enabled, themes can be set at the category level. This will affect all child categories and courses unless they have specifically set their own theme. WARNING: Enabling category themes may affect performance, as it will result in a few extra DB queries on each page, so only turn this on if you need it!

===Allow theme changes in the URL===
*If this is checked then the theme may be changed by adding <code>?theme=theme_name</code> (or <code>&theme=theme_name</code> if there are other URL parameters) to the URL in the browser. Theme names should be in lower case with spaces replaced by underscores, for example the theme "Formal white" should be entered as <code>?theme=formal_white</code>

===Allow users to hide blocks===
Allows users to display and hide blocks

===Allow blocks to use the docks===
*If the theme allows it, then checking this will allow the user to move blocks to the side dock.

===Custom menu items===
The custommenuitems setting allows you to create a drop down menu that can be displayed by themes that support it. Currently all themes that are provided with Moodle 2.0 support this custom menu.

You are able to create the custom menu by entering custom menu items one per line into the setting. Each item is preceded by a number of hyphens (-), the number of hyphens determines the depth of the item. So items that are '''NOT''' preceded by a hyphen appear on the top level of the menu (always visible), items with a single hyphen appear on a drop down menu below the previous top level item, and items with two hyphens appear on a drop down menu below the previous first level item and so on.

The content of each item is constructed of up to three bits, each separated by a '''|''' (Shift + \) character. The bits are '''label''' | '''url''' | '''tooltip'''.
; label : This is the text that will be shown within the menu item. You must specify a label for every item on the menu.
; url : This is the URL that the user will be taken to it they click the menu item. This is optional, if not provided then the item will not link anywhere.
; tooltip : If you provide a URL you can also choose to provide a tooltip for the link that is created with the URL. This is optional and if not set the label is used as the tooltip for the menu item.

The following is an example of how you would create a custom menu:

<pre>
Moodle community|http://moodle.org
-Moodle free support|http://moodle.org/support
-Moodle development|http://moodle.org/development
--Moodle Tracker|http://tracker.moodle.org
--Moodle Docs|https://docs.moodle.org
-Moodle News|http://moodle.org/news
Moodle company
-Moodle commercial hosting|http://moodle.com/hosting
-Moodle commercial support|http://moodle.com/support
</pre>

Note: The custom menu does not escape characters within the label, if you want to use a special HTML character such as an ampersand you must escape it yourself within the label. e.g. use & instead of &.

For more information on this setting please see the ''Using Moodle'' forum discussion [http://moodle.org/mod/forum/discuss.php?d=149803 Moodle 2.0: Custom menu in core]

==== Multilanguage support ====

You can add a language code (or a comma separated list of codes) as the 4th item of the line. The line will be then printed if and only if the user has currently selected the listed language. For example:

<pre><nowiki>
English only|http://moodle.com|English only item|en
German only|http://moodle.de|Deutsch|de,de_du,de_kids
</nowiki></pre>

==== Adding other attributes to the HTML ====
Other attributes, such as '''target''' can be added with escaped quotes:
<pre><nowiki>
Moodle Homepage|http://moodle.org\" target=\"_blank
</nowiki></pre>
The first escaped quote closes the href attribute, allowing other attributes to be added. All quotes for the extra attributes must be escaped as well. Do not add the closing quotation mark on the final attribute, it is added automatically by Moodle.

===Enable device detection===
Will detect mobile and tablets that identify themselves via the web browser at the time of login to Moodle. These work with the theme selector. When the theme selector has identified a default, mobile and tablet themes, this feature will use that theme.

===Device detection regular expressions===
This will allow you to customize the theme selector options. For example, you can add a custom theme for IE6 and another for Windows CE by entering the identifying expressions the browser sends and the "Return value" you want to display as the theme selectors "Device type".

==Special themes==

=== Session themes ===
Moodle offers an additional way to set a theme - the '''session theme'''. This is set with the URL and lasts until you log out. When you next login, the site/course/user themes are active again. This option is great for theme testing and works perfectly when you want to enable different themes for different situations.

For example you can offer a special link for PDA users and integrate the session theme ''orangewhitepda'' in that link. Nobody needs to change any settings, you just click on that link. The session theme is called by the URL parameter <code>&theme=orangewhitepda</code>. The whole URL without the session theme could look like <code><nowiki>http://mymoodlesite.org/course/view.php?id=18</nowiki></code> and with the parameter for the PDA theme like <code><nowiki>"http://mymoodlesite.org/course/view.php?id=18&theme=orangewhitepda"</nowiki></code>.

In a standard Moodle installation, session themes are not active. To activate them the administrator must add the parameter <code>$CFG->allowthemechangeonurl = true;</code> to the Moodle ''config.php'' file in the Moodle base directory.

=== Page theme ===
A page theme is for special page-only themes set by code, use <code>$PAGE->force_theme()</code>.

== Theme hierarchy ==
Here is the usual order that themes are considered by the Moodle interface.

{| style="border:1px dashed #ddd"
|- style="vertical-align:top;text-align:left"
!Theme type
! style="background:#eee"|Overwrites
!Display
! style="background:#eee"|Setting type
|- style="vertical-align:top"
|Site
|style="background:#eee"| -
|all pages*
|style="background:#eee"|saved in theme profile
|- style="vertical-align:top"
|User
|style="background:#eee"|Site theme
|all pages*
|style="background:#eee"|saved in user profile
|- style="vertical-align:top"
|Course
|style="background:#eee"|Site, user and session themes
|one course
|style="background:#eee"|saved in course profile
|- style="vertical-align:top"
|Session
|style="background:#eee"|Site and user themes
|all pages*
|style="background:#eee"|temporary until logout
|}
(* except courses with the course theme set)

=== Change default hierarchy===
The priority of themes can be set via the /moodle/config.php file. The order defines which theme wins when there are several set at different levels. You can set a variable called $CFG->themeorder (see config-dist.php for more details). By default it is set to:

<code><nowiki>$CFG->themeorder = array('page', 'course', 'category', 'session', 'user', 'site');</nowiki></code>

==Particular theme settings==

Logo, tagline, link colour, column width, custom CSS and other settings for a particular theme may be set by an administrator in ''Settings > Site administration > Appearance > Themes > Theme name''.

==See also==

*[http://www.youtube.com/watch?v=mCVsJ3Wsoj8 Video demonstrating how to set a category theme in Moodle 1.9]

[[es:Configuración de temas]]
[[fr:Configuration des thèmes]]
[[ja:テーマ設定]]
[[de:Design-Einstellungen]]

Blogs FAQ

2013-04-07T08:04:19Z

Tmuras:

{{Blogs}}
==How can I limit blogging to specific users only?==

See the [[Blogger role]].

==How can I change the 'Publish to' default setting?==

By default, all blog entries are published to 'Anyone on this site'. To change the default setting to 'Yourself (draft)', see the Using Moodle discussion [http://moodle.org/mod/forum/discuss.php?d=110983 Changing the Publish to Default Setting].

==How can blogs be disabled completely?==

In ''Settings > Site administration > Appearance > [[Blog]]'' set ''bloglevel'' to 'Disable blogs completely'.

==How can I backup & restore blogs?==

In 1.9 blogs were backed up & restored while doing a site backups. This has not been reimplemented for Moodle 2, so there is currently (Moodle 2.5) no way to backup blogs: [https://tracker.moodle.org/browse/MDL-22136 tracker issue].

==Viewing blogs==

===How can I see the blog of a particular person? (ie all the entries by a person)===
*In the course, Click Participants > Student Name > [a new item appears in the nav block - you need to notice it] > Blogs > you will see "View all entries by Student Name"

===How can I see all the blog entries for associated with a particular course?===
#In the blogs block > "View all entries from this course"
#In the course, click Participants > Blogs. Note: The term 'blog' here could be misleading. What you get is "Blog Posts attatched with a course", not 'blogs'.

===How can I see all the posts associated with a particular person associated with a particular course?===
*It's not currently possible to do this.

==See also==

[[Category:FAQ]]

[[de:Blog FAQ]]
[[eu:FAQ_Blogak]]

ThreeSixty module

2013-01-25T10:40:17Z

Tmuras: Created page with "{{Activities}} {{Infobox plugin |type = Activity module |entry = ... |tracker = ... |discussion = ... |maintainer = Enovation Solutions }}"

{{Activities}}
{{Infobox plugin
|type = Activity module
|entry = ...
|tracker = ...
|discussion = ...
|maintainer = Enovation Solutions
}}

Outcomes

2012-05-02T07:10:48Z

Tmuras:

{{Grades}}
Outcomes are specific descriptions of what a student has demonstrated and understood at the completion of an activity or course. Each outcome is rated by some sort of [[Scales|scale]]. Other terms for outcomes are ''Competencies'' and ''Goals''.

In simple terms outcomes are similar to sub components of a grade. A grade is an assessment of overall performance that may include tests, participation, attendance and projects. Outcomes assess specific levels of knowledge through a series of statements, that maybe coded with numbers or letters. Thus an overall grade can be given for a course, along with statements about specific competencies in the form of outcomes.

==Enabling outcomes==
# Go to ''Site administration > Advanced features'' and ensure that ''Enable outcomes'' is checked (by default, it isn't).

==Using outcomes==

# Choose or define some outcomes for your course (see below).
# For each activity, choose which of these outcomes apply using the tickbox in the activity's settings page.
# When grading that activity, grade each student using the Outcome scales. Note: You can also edit the grades in the [[Grader report]] (useful for modules that don't feature inbuilt grading).
# Use the outcomes as part of the assessment for students, or look at the Outcomes report for some useful feedback on how students in the class in general are performing.

==Outcomes report==

The outcomes report in ''Settings > Course administration > Grades > Outcomes report'' helps teachers monitor their students' progress using outcomes. It lists site-wide outcomes and custom outcomes used in the current course, their overall average (each outcome can be measured through many [[Grade items|grade items]]). It will show the name, course and site wide average, the activity, the average values and the number of "grades" given.

The outcomes report is a table with 6 columns:

*Short name - the short name of the outcome used in this course.
*Course average -shows two values representing the average scores given to students for each outcome used in this course.
*Site-wide - Whether the outcome is a site-wide outcome or not.
*Activities - This lists the activities that use this outcome in this course. A new row is created for each activity, and the activity name is linked to the activity's page.
*Average - the average score for each activity using the outcome in this course.
*Number of Grades - The number of grades given to students for each activity using the outcome.

==Outcomes used in course==

Outcomes may be set at site and/or course level. To choose outcomes for use in your course:

# View available standard outcomes in ''Settings > Course administration > Outcomes'' or via the gradebook Outcomes tab
# Add outcomes from the standard available list (right side), and use the left-facing arrow button to add them to outcomes used list (left side). Multiple outcomes may be selected by holding down the Apple or Ctrl key whilst clicking on the individual outcomes.

==Adding course-level outcomes==

[[Image:Adding an outcome.png|thumb|Adding an outcome]]To add a course-level outcome:

# Click the 'Edit outcomes' link in ''Settings > Course administration > Outcomes''
# Click the 'Add a new outcome' button.
# Complete the form then click the 'Save changes' button.

==Adding standard outcomes==

An administrator can add standard outcomes, which are available site-wide, in ''Settings > Site administration > Grades > Outcomes''. Multiple standard outcomes can be added using the import outcomes functionality (see below).

==Exporting outcomes==

Outcomes (and their associated scales) can be exported by clicking the "Export all outcomes" button. This will send a file (in .csv format) that can be read by Excel, OpenOffice.org or by any text editor.

==Importing outcomes==

Outcomes (and associated scales) may be imported by submitting a csv file. The format should be as follows:

{| class="nicetable"
|-
! Field name
! Description
! Required
! Format
|-
| outcome_name
| The full name of the outcome
| Yes
| String
|-
| outcome_shortname
| The short name of the outcome
| Yes
| String
|-
| outcome_description
| The description of the outcome
| No
| String
|-
| scale_name
| The name of the scale used
| Yes
| String
|-
| scale_items
| A comma-separated list of scale items
| Yes
| String
|-
| scale_description
| The description of the scale
| No
| String
|}

Here is an example:

outcome_name;outcome_shortname;outcome_description;scale_name;scale_items;scale_description
Participation;participation;;Participation scale;"Little or no participation, Satisfactory participation, Full participation";

To import outcomes:

# Click the 'Import outcomes' link in ''Settings > Course administration > Outcomes''
# Choose 'Import as custom outcomes (only this course)' or 'Import as standard outcomes' as required
# Upload the csv file

Note that while importing:
*Existing outcomes and scale will be used if available (no overwriting is done by the script)
*The script will stop if it detects that the file contains invalid data

==Removing selected outcomes for activities==

Previously selected outcomes are greyed out on the update activity page, however they can be removed via the gradebook on the categories and items page. They will appear in the list either below or above the activity they have been enabled in and will have the same icon as that activity. Note that if you have renamed the outcome since you assigned it to the activity, the orginal name will be displayed. Deleting the outcomes from this list will result in the outcomes being deselected on the update activity page.

==Outcomes capabilities==

* [[Capabilities/gradereport/outcomes:view|View the outcomes report]]
* [[Capabilities/moodle/grade:manageoutcomes|Manage grade outcomes]]

==See also==

*[http://www.slideshare.net/mariamoodle/outcomes-2724350 Moodle 1.9 Outcomes] External link to slide show demonstration
*[[Outcome examples]] - An example use of Outcomes
*[http://www.youtube.com/watch?v=PmkEGfvjj9U Video on how to use outcomes in Moodle]
*Using Moodle [http://moodle.org/mod/forum/discuss.php?d=78074 Outcomes in 1.9] forum discussion

[[Category:Report]]

[[es:Resultados]]
[[fr:Objectifs]]
[[ja:アウトカム]]
[[de:Lernziele]]

Flashcard module

2012-04-17T20:58:24Z

Tmuras: /* Usage */

The '''flashcard module''' may be downloaded from https://github.com/tmuras/Moodle-Flashcard/zipball/master .

The flashcard module allows editing and playing flashcards. Flashcards are a "memory training" device that uses the concept of repetition. Checking a flashcard deck will present the student the couples of relationships to be memorized. More often the associations are reviewed, deeper the memorization will be engraved into our memorial circuits.

==Features==

* Getting cards from a "matching question"
* Editing cards
* Multimedia cards: text, image, sound and image + sound together
* Automated backpropagation of cards (can be disabled)
* Customizable decks

==Configuration==

[[Flashcard module: Configuration Parameters]]

[[Flashcard module: Capabilities]]

==Usage==
===Adding new cards===
# Add new "Flash Card Set" into the course
# Enter required field "Name" and click "Save and display" button
# Click "Edit the cards" tabs - you will be brought to screen like below
[[File:flashcard1.jpg]]
# Click "Add three new questions" button
# Add text for questions and answers
# Click "Update" button

==Screens==

===Student Screens===

*[[Flashcard module: Freeplay Screen|Freeplay Screen]]
* Leitner Play Screens
** [[Flashcard module: Leitner Choose A Deck|Choose a deck to play with]]
** [[Flashcard module: Leitner Use A Deck|Use a deck]]

===Teacher Screens===

* Summary Screens
**[[Flashcard module: By User Summary|By User Summary]]
**[[Flashcard module: By Card Summary|By Card Summary]]
*[[Flashcard module: Edit Screen|Edit Screen]]

== See also ==
* [[Lesson_module#The_Flash_card_lesson|Flash card presentation]] in the [[Lesson module]] is an alternative to this module.
* Using Moodle [http://moodle.org/mod/forum/view.php?id=7180 Flashcard module forum]

[[Category:Contributed code]]
[[fr: Flashcard]]

File:flashcard1.jpg

2012-04-17T20:56:58Z

Tmuras:

Flashcard module

2012-04-17T20:56:46Z

Tmuras:

The '''flashcard module''' may be downloaded from https://github.com/tmuras/Moodle-Flashcard/zipball/master .

The flashcard module allows editing and playing flashcards. Flashcards are a "memory training" device that uses the concept of repetition. Checking a flashcard deck will present the student the couples of relationships to be memorized. More often the associations are reviewed, deeper the memorization will be engraved into our memorial circuits.

==Features==

* Getting cards from a "matching question"
* Editing cards
* Multimedia cards: text, image, sound and image + sound together
* Automated backpropagation of cards (can be disabled)
* Customizable decks

==Configuration==

[[Flashcard module: Configuration Parameters]]

[[Flashcard module: Capabilities]]

==Usage==
===Adding new cards===
# Add new "Flash Card Set" into the course
# Enter required field "Name" and click "Save and display" button
# Click "Edit the cards" tabs - you will be brought to screen like below
[[File:flashcard1.jpg]]

==Screens==

===Student Screens===

*[[Flashcard module: Freeplay Screen|Freeplay Screen]]
* Leitner Play Screens
** [[Flashcard module: Leitner Choose A Deck|Choose a deck to play with]]
** [[Flashcard module: Leitner Use A Deck|Use a deck]]

===Teacher Screens===

* Summary Screens
**[[Flashcard module: By User Summary|By User Summary]]
**[[Flashcard module: By Card Summary|By Card Summary]]
*[[Flashcard module: Edit Screen|Edit Screen]]

== See also ==
* [[Lesson_module#The_Flash_card_lesson|Flash card presentation]] in the [[Lesson module]] is an alternative to this module.
* Using Moodle [http://moodle.org/mod/forum/view.php?id=7180 Flashcard module forum]

[[Category:Contributed code]]
[[fr: Flashcard]]

Upgrading

2012-04-02T09:11:44Z

Tmuras: /* Using CVS */

{{Installing Moodle}}
'''Before you do anything else, read [[Upgrading to Moodle 2.2]]'''

Moodle is designed to upgrade itself from one version to the next. The procedure is
# [[Site backup|Back up everything]].
# Replace the old version of the code with the new one.
# Visit the [[Site_administration_block#Notifications|administrator notifications]] link, which triggers Moodle to self-update.
These steps are explained in more detail below.

Sometimes there are specific considerations when upgrading to a particular version. See the [[dev:Releases|Releases page]] for more information on this. You also have to be more careful if you have installed additional plug-ins or customised the code.

See this tutorial if you are [http://ic.eflclasses.org/tutorials/howtoupgrademoodlewithcpanel.swf upgrading Moodle on cpanel]. It is a bit rough around the edges and is a little dated, but you should get the idea.

There is also a separate page about [[Ubuntu_Debian_Upgrades|upgrading Moodle if you installed it using the Ubuntu/Kubuntu/Debian package manager]].

__TOC__

When upgrading a Moodle installation you should follow these steps:

==Before you upgrade your site for real==

You are strongly advised to make a copy of your entire Moodle site onto another computer (see [[Moodle migration]]) and run the upgrade there to verify it will work. If you decide not to do this, make sure you have good backups. If the upgrade fails you will need the backups to go back.

==Check the requirements==
Spend some time re-reading the [[Installing Moodle | installation documentation]] and documentation for the new version. Check the system requirements for the target version you want to upgrade-to in ''Settings > Site administration > Server > [[Environment]]''.

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

== Backup important data ==
See [[Site backup]] for more specific information.

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, the SQL or Postgres database)

Experienced site administrators know that it is a best practice (a very good idea) to make a backup of any production system before a major upgrade. In fact, it is a good idea to automate your server to backup your Moodle installation daily. Most upgrades on sites that have used the standard Moodle packages (no contributed code and no little tweaks to the php files), will not have any major issues with the upgrade process.

:''TIP:'' One more time, "do not risk what you can not afford to lose": do regular backups, make sure it is really backed up and know how to restore a backup!

== Install the new Moodle software ==
Upgrading can be a simple process or a more complicated process. Sites that have not used contributed code and are migrating from say Moodle 2.x.1 to 2.x.3 '''should''' not have a problem. However, we still recommend that with any production server that you have made a successful backup of the MySQL database, the moodledata directory and the moodle program folders and files.

*Do not overwrite an old installation unless you know what you are doing ... sometimes old files can cause problems in new installations. Review the backup section above.

=== Standard install package ===
Having read the cautions about backups, download a copy of the standard install package. Here is a set of simple instructions for an average site.
*It is probably a good idea to use the [[Site administration block]]>Server>Maintenance mode to prevent user activity as the site upgrades.
*Having moved your old Moodle software program files to another location, unzip or unpack the upgrade file so that all new the Moodle software program files are in the location the old files used to be in on the server. Moodle will adjust SQL and [[Moodledata directory|moodledata]] if it needs to in the upgrade.
*Copy your old [[Configuration file|config.php file]] back to the new Moodle directory. If you've defined individual blocks for new courses you have to delete 'admin' block definition and replace by 'settings' for the new block.
*If you had added any custom plugins or themes into your Moodle you can add them to the new code. It is important to check that you get the correct version for your new version of Moodle. You should check in the optional plugins database. Be particularly careful that you do not overwrite any code in the new version of Moodle. If you are upgrading to Moodle 2.0 or newer, note that all optional plugins and themes required a significant rewrite and most do not have 2.0 versions (yet).
*Use the notification link in the site administration to start the upgrade process. You will see a series of lines or screens indicating progress.
*After a successful upgrade, turn off the maintenance mode, so your users can get into the site.

=== Using a downloaded archive ===
In some installs, the site administrator may overwrite the Moodle code with a backup copy. Or create a new clean install copy of Moodle, then restore an archive (via a compressed file or parts of a saved set of Moodle code files and folders).

*Do not overwrite an old installation unless you know what you are doing ... sometimes old files can cause problems in new or "cleaned" installations. The best way is to rename the current Moodle code directory (for example rename "moodle" to "moodleold"), then unpack the new Moodle archive into the old location (for example, a new directory called "moodle").

====Linux====
mv moodle moodle.backup
tar xvzf moodle-1.1.tgz

Next, copy across your config.php, any other plugins such as custom themes, and your .htaccess file if you created one ('''check that optional/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 writable 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. New sites are recommended to use this rather than CVS since all Moodle development has moved to Git.

See [[Git for Administrators]] for further details.

== Finishing the upgrade ==

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

To do this just visit the [[Site administration block]] admin page (or ''<nowiki>http://example.com/moodle/admin</nowiki>'') and the "Notifications" link.

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!

:''TIP:'' Use the site administration block>Server>Maintenance mode to prevent users from changing data during the upgrade.
:''TIP:'' If you are running a large scale Moodle site (e.g. have more tha 10,000+ courses and 40,000+ users), make sure that you do your own performance profiling testing. Post a thread or check the [http://moodle.org/mod/forum/view.php?id=28 Installation problems forum] and check [[Tracker]] for potential issues.

== Verify the upgrade (optional) ==

If you wish to confirm that the database definitions in the upgraded database match the definitions of a new, clean install (which they should) you might like to look at [[Verify Database Schema]].

==Upgrading more than one version==

Normally you can upgrade directly from any Moodle version to any later version. So, for example you could upgrade from 2.0 to 2.1, or from 1.9 to 2.2.

However, every so often, this general rule gets broken, because supporting really large jumps (for example Moodle 1.6 to 2.2 in one step) would be impossible. Recent break points have been:
* You must have upgraded to version 1.9.x before you can upgrade to a later 2.x version.
* You must have upgraded to version 2.2.x before you can upgrade to 2.3 or later.

If you are upgrading from a pre-1.6 version it is recommended that you upgrade first to the latest 1.6.x, then to the latest 1.9.x and finally to the latest 2.x. See Petr's forum post [http://moodle.org/mod/forum/discuss.php?d=197602#p861964 Re: Continuing on Upgrade docs] for further information.

==See also==

*[[Environment]]
*[[Git]] Version control and upgrading
*[[How to fix just one bug without upgrading]]
*Moodle.org [http://moodle.org/mod/forum/view.php?id=28 Installation problems forum]
*[http://ic.eflclasses.org/tutorials/howtoupgrademoodlewithcpanel.swf How to upgrade Moodle with cpanel tutorial] - screencasts of older Moodle/Cpanel install but useful (also, a very large file that will take some time to load).

Documentation on upgrading to particular versions:
*[[Upgrading to Moodle 2.2]]
*[https://docs.moodle.org/21/en/Upgrading_to_Moodle_2.1 Upgrading to Moodle 2.1]
*[https://docs.moodle.org/20/en/Upgrading_to_Moodle_2.0 Upgrading to Moodle 2.0]
*[https://docs.moodle.org/19/en/Upgrading_to_Moodle_1.9 Upgrading to Moodle 1.9]
*[https://docs.moodle.org/19/en/Upgrading_to_Moodle_1.8 Upgrading to Moodle 1.8]
*[https://docs.moodle.org/19/en/Upgrading_to_Moodle_1.7 Upgrading to Moodle 1.7]
*[https://docs.moodle.org/19/en/Upgrading_to_Moodle_1.6 Upgrading to Moodle 1.6]

Using Moodle.org forum discussions:
*[http://moodle.org/mod/forum/discuss.php?d=104887 Best practices for QA]
*[http://moodle.org/mod/forum/discuss.php?d=198123 Language customizations lost on upgrade]
*[[Beginning_Moodle_2.0_Administration|Beginning Moodle 2.0 Administration]]

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

Upgrading

2012-04-02T09:07:27Z

Tmuras: /* Linux */

{{Installing Moodle}}
'''Before you do anything else, read [[Upgrading to Moodle 2.2]]'''

Moodle is designed to upgrade itself from one version to the next. The procedure is
# [[Site backup|Back up everything]].
# Replace the old version of the code with the new one.
# Visit the [[Site_administration_block#Notifications|administrator notifications]] link, which triggers Moodle to self-update.
These steps are explained in more detail below.

Sometimes there are specific considerations when upgrading to a particular version. See the [[dev:Releases|Releases page]] for more information on this. You also have to be more careful if you have installed additional plug-ins or customised the code.

See this tutorial if you are [http://ic.eflclasses.org/tutorials/howtoupgrademoodlewithcpanel.swf upgrading Moodle on cpanel]. It is a bit rough around the edges and is a little dated, but you should get the idea.

There is also a separate page about [[Ubuntu_Debian_Upgrades|upgrading Moodle if you installed it using the Ubuntu/Kubuntu/Debian package manager]].

__TOC__

When upgrading a Moodle installation you should follow these steps:

==Before you upgrade your site for real==

You are strongly advised to make a copy of your entire Moodle site onto another computer (see [[Moodle migration]]) and run the upgrade there to verify it will work. If you decide not to do this, make sure you have good backups. If the upgrade fails you will need the backups to go back.

==Check the requirements==
Spend some time re-reading the [[Installing Moodle | installation documentation]] and documentation for the new version. Check the system requirements for the target version you want to upgrade-to in ''Settings > Site administration > Server > [[Environment]]''.

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

== Backup important data ==
See [[Site backup]] for more specific information.

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, the SQL or Postgres database)

Experienced site administrators know that it is a best practice (a very good idea) to make a backup of any production system before a major upgrade. In fact, it is a good idea to automate your server to backup your Moodle installation daily. Most upgrades on sites that have used the standard Moodle packages (no contributed code and no little tweaks to the php files), will not have any major issues with the upgrade process.

:''TIP:'' One more time, "do not risk what you can not afford to lose": do regular backups, make sure it is really backed up and know how to restore a backup!

== Install the new Moodle software ==
Upgrading can be a simple process or a more complicated process. Sites that have not used contributed code and are migrating from say Moodle 2.x.1 to 2.x.3 '''should''' not have a problem. However, we still recommend that with any production server that you have made a successful backup of the MySQL database, the moodledata directory and the moodle program folders and files.

*Do not overwrite an old installation unless you know what you are doing ... sometimes old files can cause problems in new installations. Review the backup section above.

=== Standard install package ===
Having read the cautions about backups, download a copy of the standard install package. Here is a set of simple instructions for an average site.
*It is probably a good idea to use the [[Site administration block]]>Server>Maintenance mode to prevent user activity as the site upgrades.
*Having moved your old Moodle software program files to another location, unzip or unpack the upgrade file so that all new the Moodle software program files are in the location the old files used to be in on the server. Moodle will adjust SQL and [[Moodledata directory|moodledata]] if it needs to in the upgrade.
*Copy your old [[Configuration file|config.php file]] back to the new Moodle directory. If you've defined individual blocks for new courses you have to delete 'admin' block definition and replace by 'settings' for the new block.
*If you had added any custom plugins or themes into your Moodle you can add them to the new code. It is important to check that you get the correct version for your new version of Moodle. You should check in the optional plugins database. Be particularly careful that you do not overwrite any code in the new version of Moodle. If you are upgrading to Moodle 2.0 or newer, note that all optional plugins and themes required a significant rewrite and most do not have 2.0 versions (yet).
*Use the notification link in the site administration to start the upgrade process. You will see a series of lines or screens indicating progress.
*After a successful upgrade, turn off the maintenance mode, so your users can get into the site.

=== Using a downloaded archive ===
In some installs, the site administrator may overwrite the Moodle code with a backup copy. Or create a new clean install copy of Moodle, then restore an archive (via a compressed file or parts of a saved set of Moodle code files and folders).

*Do not overwrite an old installation unless you know what you are doing ... sometimes old files can cause problems in new or "cleaned" installations. The best way is to rename the current Moodle code directory (for example rename "moodle" to "moodleold"), then unpack the new Moodle archive into the old location (for example, a new directory called "moodle").

====Linux====
mv moodle moodle.backup
tar xvzf moodle-1.1.tgz

Next, copy across your config.php, any other plugins such as custom themes, and your .htaccess file if you created one ('''check that optional/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 writable 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 CVS ===

New sites should now use Git rather than CVS (see next section). If your site already uses CVS, to update, just go into the Moodle root directory and update to the new files:
<pre>
$ cd /path/to/your/moodle/
$ cvs update -dP
</pre>
To update from an older version type in the following:
<pre>
$ cd /path/to/your/moodle/
$ cvs -Q update -dP -r MOODLE_18_STABLE
</pre>

Make sure you use the "d" parameter to create new directories if necessary, and the "P" parameter to prune empty directories.

=== Using Git ===

You can use [[Git]] for updating or upgrading your Moodle. New sites are recommended to use this rather than CVS since all Moodle development has moved to Git.

See [[Git for Administrators]] for further details.

== Finishing the upgrade ==

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

To do this just visit the [[Site administration block]] admin page (or ''<nowiki>http://example.com/moodle/admin</nowiki>'') and the "Notifications" link.

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!

:''TIP:'' Use the site administration block>Server>Maintenance mode to prevent users from changing data during the upgrade.
:''TIP:'' If you are running a large scale Moodle site (e.g. have more tha 10,000+ courses and 40,000+ users), make sure that you do your own performance profiling testing. Post a thread or check the [http://moodle.org/mod/forum/view.php?id=28 Installation problems forum] and check [[Tracker]] for potential issues.

== Verify the upgrade (optional) ==

If you wish to confirm that the database definitions in the upgraded database match the definitions of a new, clean install (which they should) you might like to look at [[Verify Database Schema]].

==Upgrading more than one version==

Normally you can upgrade directly from any Moodle version to any later version. So, for example you could upgrade from 2.0 to 2.1, or from 1.9 to 2.2.

However, every so often, this general rule gets broken, because supporting really large jumps (for example Moodle 1.6 to 2.2 in one step) would be impossible. Recent break points have been:
* You must have upgraded to version 1.9.x before you can upgrade to a later 2.x version.
* You must have upgraded to version 2.2.x before you can upgrade to 2.3 or later.

If you are upgrading from a pre-1.6 version it is recommended that you upgrade first to the latest 1.6.x, then to the latest 1.9.x and finally to the latest 2.x. See Petr's forum post [http://moodle.org/mod/forum/discuss.php?d=197602#p861964 Re: Continuing on Upgrade docs] for further information.

==See also==

*[[Environment]]
*[[Git]] Version control and upgrading
*[[How to fix just one bug without upgrading]]
*Moodle.org [http://moodle.org/mod/forum/view.php?id=28 Installation problems forum]
*[http://ic.eflclasses.org/tutorials/howtoupgrademoodlewithcpanel.swf How to upgrade Moodle with cpanel tutorial] - screencasts of older Moodle/Cpanel install but useful (also, a very large file that will take some time to load).

Documentation on upgrading to particular versions:
*[[Upgrading to Moodle 2.2]]
*[https://docs.moodle.org/21/en/Upgrading_to_Moodle_2.1 Upgrading to Moodle 2.1]
*[https://docs.moodle.org/20/en/Upgrading_to_Moodle_2.0 Upgrading to Moodle 2.0]
*[https://docs.moodle.org/19/en/Upgrading_to_Moodle_1.9 Upgrading to Moodle 1.9]
*[https://docs.moodle.org/19/en/Upgrading_to_Moodle_1.8 Upgrading to Moodle 1.8]
*[https://docs.moodle.org/19/en/Upgrading_to_Moodle_1.7 Upgrading to Moodle 1.7]
*[https://docs.moodle.org/19/en/Upgrading_to_Moodle_1.6 Upgrading to Moodle 1.6]

Using Moodle.org forum discussions:
*[http://moodle.org/mod/forum/discuss.php?d=104887 Best practices for QA]
*[http://moodle.org/mod/forum/discuss.php?d=198123 Language customizations lost on upgrade]
*[[Beginning_Moodle_2.0_Administration|Beginning Moodle 2.0 Administration]]

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

Upgrading

2012-04-02T09:05:07Z

Tmuras: /* Linux */

{{Installing Moodle}}
'''Before you do anything else, read [[Upgrading to Moodle 2.2]]'''

Moodle is designed to upgrade itself from one version to the next. The procedure is
# [[Site backup|Back up everything]].
# Replace the old version of the code with the new one.
# Visit the [[Site_administration_block#Notifications|administrator notifications]] link, which triggers Moodle to self-update.
These steps are explained in more detail below.

Sometimes there are specific considerations when upgrading to a particular version. See the [[dev:Releases|Releases page]] for more information on this. You also have to be more careful if you have installed additional plug-ins or customised the code.

See this tutorial if you are [http://ic.eflclasses.org/tutorials/howtoupgrademoodlewithcpanel.swf upgrading Moodle on cpanel]. It is a bit rough around the edges and is a little dated, but you should get the idea.

There is also a separate page about [[Ubuntu_Debian_Upgrades|upgrading Moodle if you installed it using the Ubuntu/Kubuntu/Debian package manager]].

__TOC__

When upgrading a Moodle installation you should follow these steps:

==Before you upgrade your site for real==

You are strongly advised to make a copy of your entire Moodle site onto another computer (see [[Moodle migration]]) and run the upgrade there to verify it will work. If you decide not to do this, make sure you have good backups. If the upgrade fails you will need the backups to go back.

==Check the requirements==
Spend some time re-reading the [[Installing Moodle | installation documentation]] and documentation for the new version. Check the system requirements for the target version you want to upgrade-to in ''Settings > Site administration > Server > [[Environment]]''.

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

== Backup important data ==
See [[Site backup]] for more specific information.

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, the SQL or Postgres database)

Experienced site administrators know that it is a best practice (a very good idea) to make a backup of any production system before a major upgrade. In fact, it is a good idea to automate your server to backup your Moodle installation daily. Most upgrades on sites that have used the standard Moodle packages (no contributed code and no little tweaks to the php files), will not have any major issues with the upgrade process.

:''TIP:'' One more time, "do not risk what you can not afford to lose": do regular backups, make sure it is really backed up and know how to restore a backup!

== Install the new Moodle software ==
Upgrading can be a simple process or a more complicated process. Sites that have not used contributed code and are migrating from say Moodle 2.x.1 to 2.x.3 '''should''' not have a problem. However, we still recommend that with any production server that you have made a successful backup of the MySQL database, the moodledata directory and the moodle program folders and files.

*Do not overwrite an old installation unless you know what you are doing ... sometimes old files can cause problems in new installations. Review the backup section above.

=== Standard install package ===
Having read the cautions about backups, download a copy of the standard install package. Here is a set of simple instructions for an average site.
*It is probably a good idea to use the [[Site administration block]]>Server>Maintenance mode to prevent user activity as the site upgrades.
*Having moved your old Moodle software program files to another location, unzip or unpack the upgrade file so that all new the Moodle software program files are in the location the old files used to be in on the server. Moodle will adjust SQL and [[Moodledata directory|moodledata]] if it needs to in the upgrade.
*Copy your old [[Configuration file|config.php file]] back to the new Moodle directory. If you've defined individual blocks for new courses you have to delete 'admin' block definition and replace by 'settings' for the new block.
*If you had added any custom plugins or themes into your Moodle you can add them to the new code. It is important to check that you get the correct version for your new version of Moodle. You should check in the optional plugins database. Be particularly careful that you do not overwrite any code in the new version of Moodle. If you are upgrading to Moodle 2.0 or newer, note that all optional plugins and themes required a significant rewrite and most do not have 2.0 versions (yet).
*Use the notification link in the site administration to start the upgrade process. You will see a series of lines or screens indicating progress.
*After a successful upgrade, turn off the maintenance mode, so your users can get into the site.

=== Using a downloaded archive ===
In some installs, the site administrator may overwrite the Moodle code with a backup copy. Or create a new clean install copy of Moodle, then restore an archive (via a compressed file or parts of a saved set of Moodle code files and folders).

*Do not overwrite an old installation unless you know what you are doing ... sometimes old files can cause problems in new or "cleaned" installations. The best way is to rename the current Moodle code directory (for example rename "moodle" to "moodleold"), then unpack the new Moodle archive into the old location (for example, a new directory called "moodle").

====Linux====
mv moodle moodle.backup
tar xvzf moodle-1.1.tgz

Next, copy across your config.php, any other plugins such as custom themes, and your .htaccess file if you created one ('''check that optional/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 readable by your www 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 CVS ===

New sites should now use Git rather than CVS (see next section). If your site already uses CVS, to update, just go into the Moodle root directory and update to the new files:
<pre>
$ cd /path/to/your/moodle/
$ cvs update -dP
</pre>
To update from an older version type in the following:
<pre>
$ cd /path/to/your/moodle/
$ cvs -Q update -dP -r MOODLE_18_STABLE
</pre>

Make sure you use the "d" parameter to create new directories if necessary, and the "P" parameter to prune empty directories.

=== Using Git ===

You can use [[Git]] for updating or upgrading your Moodle. New sites are recommended to use this rather than CVS since all Moodle development has moved to Git.

See [[Git for Administrators]] for further details.

== Finishing the upgrade ==

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

To do this just visit the [[Site administration block]] admin page (or ''<nowiki>http://example.com/moodle/admin</nowiki>'') and the "Notifications" link.

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!

:''TIP:'' Use the site administration block>Server>Maintenance mode to prevent users from changing data during the upgrade.
:''TIP:'' If you are running a large scale Moodle site (e.g. have more tha 10,000+ courses and 40,000+ users), make sure that you do your own performance profiling testing. Post a thread or check the [http://moodle.org/mod/forum/view.php?id=28 Installation problems forum] and check [[Tracker]] for potential issues.

== Verify the upgrade (optional) ==

If you wish to confirm that the database definitions in the upgraded database match the definitions of a new, clean install (which they should) you might like to look at [[Verify Database Schema]].

==Upgrading more than one version==

Normally you can upgrade directly from any Moodle version to any later version. So, for example you could upgrade from 2.0 to 2.1, or from 1.9 to 2.2.

However, every so often, this general rule gets broken, because supporting really large jumps (for example Moodle 1.6 to 2.2 in one step) would be impossible. Recent break points have been:
* You must have upgraded to version 1.9.x before you can upgrade to a later 2.x version.
* You must have upgraded to version 2.2.x before you can upgrade to 2.3 or later.

If you are upgrading from a pre-1.6 version it is recommended that you upgrade first to the latest 1.6.x, then to the latest 1.9.x and finally to the latest 2.x. See Petr's forum post [http://moodle.org/mod/forum/discuss.php?d=197602#p861964 Re: Continuing on Upgrade docs] for further information.

==See also==

*[[Environment]]
*[[Git]] Version control and upgrading
*[[How to fix just one bug without upgrading]]
*Moodle.org [http://moodle.org/mod/forum/view.php?id=28 Installation problems forum]
*[http://ic.eflclasses.org/tutorials/howtoupgrademoodlewithcpanel.swf How to upgrade Moodle with cpanel tutorial] - screencasts of older Moodle/Cpanel install but useful (also, a very large file that will take some time to load).

Documentation on upgrading to particular versions:
*[[Upgrading to Moodle 2.2]]
*[https://docs.moodle.org/21/en/Upgrading_to_Moodle_2.1 Upgrading to Moodle 2.1]
*[https://docs.moodle.org/20/en/Upgrading_to_Moodle_2.0 Upgrading to Moodle 2.0]
*[https://docs.moodle.org/19/en/Upgrading_to_Moodle_1.9 Upgrading to Moodle 1.9]
*[https://docs.moodle.org/19/en/Upgrading_to_Moodle_1.8 Upgrading to Moodle 1.8]
*[https://docs.moodle.org/19/en/Upgrading_to_Moodle_1.7 Upgrading to Moodle 1.7]
*[https://docs.moodle.org/19/en/Upgrading_to_Moodle_1.6 Upgrading to Moodle 1.6]

Using Moodle.org forum discussions:
*[http://moodle.org/mod/forum/discuss.php?d=104887 Best practices for QA]
*[http://moodle.org/mod/forum/discuss.php?d=198123 Language customizations lost on upgrade]
*[[Beginning_Moodle_2.0_Administration|Beginning Moodle 2.0 Administration]]

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

Upgrading

2012-04-02T09:03:45Z

Tmuras: /* Linux */

{{Installing Moodle}}
'''Before you do anything else, read [[Upgrading to Moodle 2.2]]'''

Moodle is designed to upgrade itself from one version to the next. The procedure is
# [[Site backup|Back up everything]].
# Replace the old version of the code with the new one.
# Visit the [[Site_administration_block#Notifications|administrator notifications]] link, which triggers Moodle to self-update.
These steps are explained in more detail below.

Sometimes there are specific considerations when upgrading to a particular version. See the [[dev:Releases|Releases page]] for more information on this. You also have to be more careful if you have installed additional plug-ins or customised the code.

See this tutorial if you are [http://ic.eflclasses.org/tutorials/howtoupgrademoodlewithcpanel.swf upgrading Moodle on cpanel]. It is a bit rough around the edges and is a little dated, but you should get the idea.

There is also a separate page about [[Ubuntu_Debian_Upgrades|upgrading Moodle if you installed it using the Ubuntu/Kubuntu/Debian package manager]].

__TOC__

When upgrading a Moodle installation you should follow these steps:

==Before you upgrade your site for real==

You are strongly advised to make a copy of your entire Moodle site onto another computer (see [[Moodle migration]]) and run the upgrade there to verify it will work. If you decide not to do this, make sure you have good backups. If the upgrade fails you will need the backups to go back.

==Check the requirements==
Spend some time re-reading the [[Installing Moodle | installation documentation]] and documentation for the new version. Check the system requirements for the target version you want to upgrade-to in ''Settings > Site administration > Server > [[Environment]]''.

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

== Backup important data ==
See [[Site backup]] for more specific information.

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, the SQL or Postgres database)

Experienced site administrators know that it is a best practice (a very good idea) to make a backup of any production system before a major upgrade. In fact, it is a good idea to automate your server to backup your Moodle installation daily. Most upgrades on sites that have used the standard Moodle packages (no contributed code and no little tweaks to the php files), will not have any major issues with the upgrade process.

:''TIP:'' One more time, "do not risk what you can not afford to lose": do regular backups, make sure it is really backed up and know how to restore a backup!

== Install the new Moodle software ==
Upgrading can be a simple process or a more complicated process. Sites that have not used contributed code and are migrating from say Moodle 2.x.1 to 2.x.3 '''should''' not have a problem. However, we still recommend that with any production server that you have made a successful backup of the MySQL database, the moodledata directory and the moodle program folders and files.

*Do not overwrite an old installation unless you know what you are doing ... sometimes old files can cause problems in new installations. Review the backup section above.

=== Standard install package ===
Having read the cautions about backups, download a copy of the standard install package. Here is a set of simple instructions for an average site.
*It is probably a good idea to use the [[Site administration block]]>Server>Maintenance mode to prevent user activity as the site upgrades.
*Having moved your old Moodle software program files to another location, unzip or unpack the upgrade file so that all new the Moodle software program files are in the location the old files used to be in on the server. Moodle will adjust SQL and [[Moodledata directory|moodledata]] if it needs to in the upgrade.
*Copy your old [[Configuration file|config.php file]] back to the new Moodle directory. If you've defined individual blocks for new courses you have to delete 'admin' block definition and replace by 'settings' for the new block.
*If you had added any custom plugins or themes into your Moodle you can add them to the new code. It is important to check that you get the correct version for your new version of Moodle. You should check in the optional plugins database. Be particularly careful that you do not overwrite any code in the new version of Moodle. If you are upgrading to Moodle 2.0 or newer, note that all optional plugins and themes required a significant rewrite and most do not have 2.0 versions (yet).
*Use the notification link in the site administration to start the upgrade process. You will see a series of lines or screens indicating progress.
*After a successful upgrade, turn off the maintenance mode, so your users can get into the site.

=== Using a downloaded archive ===
In some installs, the site administrator may overwrite the Moodle code with a backup copy. Or create a new clean install copy of Moodle, then restore an archive (via a compressed file or parts of a saved set of Moodle code files and folders).

*Do not overwrite an old installation unless you know what you are doing ... sometimes old files can cause problems in new or "cleaned" installations. The best way is to rename the current Moodle code directory (for example rename "moodle" to "moodleold"), then unpack the new Moodle archive into the old location (for example, a new directory called "moodle").

====Linux====
mv moodle moodle.backup
tar xvzf moodle-1.1.tgz

Next, copy across your config.php, any other plugins such as custom themes, and your .htaccess file if you created one ('''check that optional/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 readable by your www 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)
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.

where www-data is whatever user the Apache user is on your system. This is often 'apache' or 'www'.
You can find out by doing 'ls -l' in your /var/www/moodle folder (or wherever your moodle site is)
and then looking at the owner and group.

so you may see something like

ls -l
...lots of lines...
-rw-r--r-- 1 apache system 784 Jun 28 2007 config.php
...lots more lines...

so the owner is apache and the group is system.

To replicate this on your new system you can do 'chown apache:system config.php'

or to do a whole group do

chown apache:system ./*

and recursively

chown -R apache:system ./*

=== Using CVS ===

New sites should now use Git rather than CVS (see next section). If your site already uses CVS, to update, just go into the Moodle root directory and update to the new files:
<pre>
$ cd /path/to/your/moodle/
$ cvs update -dP
</pre>
To update from an older version type in the following:
<pre>
$ cd /path/to/your/moodle/
$ cvs -Q update -dP -r MOODLE_18_STABLE
</pre>

Make sure you use the "d" parameter to create new directories if necessary, and the "P" parameter to prune empty directories.

=== Using Git ===

You can use [[Git]] for updating or upgrading your Moodle. New sites are recommended to use this rather than CVS since all Moodle development has moved to Git.

See [[Git for Administrators]] for further details.

== Finishing the upgrade ==

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

To do this just visit the [[Site administration block]] admin page (or ''<nowiki>http://example.com/moodle/admin</nowiki>'') and the "Notifications" link.

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!

:''TIP:'' Use the site administration block>Server>Maintenance mode to prevent users from changing data during the upgrade.
:''TIP:'' If you are running a large scale Moodle site (e.g. have more tha 10,000+ courses and 40,000+ users), make sure that you do your own performance profiling testing. Post a thread or check the [http://moodle.org/mod/forum/view.php?id=28 Installation problems forum] and check [[Tracker]] for potential issues.

== Verify the upgrade (optional) ==

If you wish to confirm that the database definitions in the upgraded database match the definitions of a new, clean install (which they should) you might like to look at [[Verify Database Schema]].

==Upgrading more than one version==

Normally you can upgrade directly from any Moodle version to any later version. So, for example you could upgrade from 2.0 to 2.1, or from 1.9 to 2.2.

However, every so often, this general rule gets broken, because supporting really large jumps (for example Moodle 1.6 to 2.2 in one step) would be impossible. Recent break points have been:
* You must have upgraded to version 1.9.x before you can upgrade to a later 2.x version.
* You must have upgraded to version 2.2.x before you can upgrade to 2.3 or later.

If you are upgrading from a pre-1.6 version it is recommended that you upgrade first to the latest 1.6.x, then to the latest 1.9.x and finally to the latest 2.x. See Petr's forum post [http://moodle.org/mod/forum/discuss.php?d=197602#p861964 Re: Continuing on Upgrade docs] for further information.

==See also==

*[[Environment]]
*[[Git]] Version control and upgrading
*[[How to fix just one bug without upgrading]]
*Moodle.org [http://moodle.org/mod/forum/view.php?id=28 Installation problems forum]
*[http://ic.eflclasses.org/tutorials/howtoupgrademoodlewithcpanel.swf How to upgrade Moodle with cpanel tutorial] - screencasts of older Moodle/Cpanel install but useful (also, a very large file that will take some time to load).

Documentation on upgrading to particular versions:
*[[Upgrading to Moodle 2.2]]
*[https://docs.moodle.org/21/en/Upgrading_to_Moodle_2.1 Upgrading to Moodle 2.1]
*[https://docs.moodle.org/20/en/Upgrading_to_Moodle_2.0 Upgrading to Moodle 2.0]
*[https://docs.moodle.org/19/en/Upgrading_to_Moodle_1.9 Upgrading to Moodle 1.9]
*[https://docs.moodle.org/19/en/Upgrading_to_Moodle_1.8 Upgrading to Moodle 1.8]
*[https://docs.moodle.org/19/en/Upgrading_to_Moodle_1.7 Upgrading to Moodle 1.7]
*[https://docs.moodle.org/19/en/Upgrading_to_Moodle_1.6 Upgrading to Moodle 1.6]

Using Moodle.org forum discussions:
*[http://moodle.org/mod/forum/discuss.php?d=104887 Best practices for QA]
*[http://moodle.org/mod/forum/discuss.php?d=198123 Language customizations lost on upgrade]
*[[Beginning_Moodle_2.0_Administration|Beginning Moodle 2.0 Administration]]

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

Flashcard module

2011-06-12T10:18:02Z

Tmuras:

The '''flashcard module''' may be downloaded from https://github.com/tmuras/Moodle-Flashcard/zipball/master .

The flashcard module allows editing and playing flashcards. Flashcards are a "memory training" device that uses the concept of repetition. Checking a flashcard deck will present the student the couples of relationships to be memorized. More often the associations are reviewed, deeper the memorization will be engraved into our memorial circuits.

==Features==

* Getting cards from a "matching question"
* Editing cards
* Multimedia cards: text, image, sound and image + sound together
* Automated backpropagation of cards (can be disabled)
* Customizable decks

==Configuration==

[[Flashcard module: Configuration Parameters]]

[[Flashcard module: Capabilities]]

==Screens==

===Student Screens===

*[[Flashcard module: Freeplay Screen|Freeplay Screen]]
* Leitner Play Screens
** [[Flashcard module: Leitner Choose A Deck|Choose a deck to play with]]
** [[Flashcard module: Leitner Use A Deck|Use a deck]]

===Teacher Screens===

* Summary Screens
**[[Flashcard module: By User Summary|By User Summary]]
**[[Flashcard module: By Card Summary|By Card Summary]]
*[[Flashcard module: Edit Screen|Edit Screen]]

== See also ==
* [[Lesson_module#The_Flash_card_lesson|Flash card presentation]] in the [[Lesson module]] is an alternative to this module.
* Using Moodle [http://moodle.org/mod/forum/view.php?id=7180 Flashcard module forum]

[[Category:Contributed code]]
[[fr: Flashcard]]

Flashcard module

2011-04-02T09:06:09Z

Tmuras:

The '''flashcard module''' may be downloaded (for Moodle 2.0) from https://github.com/tmuras/Moodle-Flashcard/zipball/master (updated on 2 Apr 2011) .

Actual stable version is at http://download.moodle.org/plugins19/mod/flashcard.zip .

The flashcard module allows editing and playing flashcards. Flashcards are a "memory training" device that uses the concept of repetition. Checking a flashcard deck will present the student the couples of relationships to be memorized. More often the associations are reviewed, deeper the memorization will be engraved into our memorial circuits.

==Features==

* Getting cards from a "matching question"
* Editing cards
* Multimedia cards: text, image, sound and image + sound together
* Automated backpropagation of cards (can be disabled)
* Customizable decks

==Configuration==

[[Flashcard module: Configuration Parameters]]

[[Flashcard module: Capabilities]]

==Screens==

===Student Screens===

*[[Flashcard module: Freeplay Screen|Freeplay Screen]]
* Leitner Play Screens
** [[Flashcard module: Leitner Choose A Deck|Choose a deck to play with]]
** [[Flashcard module: Leitner Use A Deck|Use a deck]]

===Teacher Screens===

* Summary Screens
**[[Flashcard module: By User Summary|By User Summary]]
**[[Flashcard module: By Card Summary|By Card Summary]]
*[[Flashcard module: Edit Screen|Edit Screen]]

== See also ==
* [[Lesson_module#The_Flash_card_lesson|Flash card presentation]] in the [[Lesson module]] is an alternative to this module.
* Using Moodle [http://moodle.org/mod/forum/view.php?id=7180 Flashcard module forum]

[[Category:Contributed code]]
[[fr: Flashcard]]

File:timetrack reportscreen.jpg

2011-01-18T10:25:56Z

Tmuras:

File:timetrack entryscreenerror.jpg

2011-01-18T10:25:29Z

Tmuras:

File:timetrackblock.jpg

2011-01-18T10:24:15Z

Tmuras: