MoodleDocs - User contributions [en]

Upload courses

2022-02-24T07:17:44Z

Plemaire: /* Short file example */ Layout for rendering one line for each

{{Courses}}
{{Note|This page is about creating courses with a text (.csv) file. If you want to upload a course backup in .mbz or .tgz format, see [[Course restore]].}}
==Upload courses==
In addition to creating new courses, the upload courses functionality may also be used to update or delete courses, or import content from another course. For information on using this functionality to create course templates, see [[Adding a new course]].

To upload one or more courses
#Go to ''Administration > Site administration > Courses > Upload courses''
#Either drag and drop the CSV file or click the 'Choose a file' button and select the file in the file picker
#Select appropriate import options carefully, then click the preview button.
{|
|[[File:26uploadcourses.png|250px|thumb|Upload courses admin screen]]
|
|[[File:uploadcoursesresults.png|250px|thumb|Courses successfully uploaded]]
|}
Note: It is also possible to use the command-line tool ''admin/tool/uploadcourse/cli/uploadcourse.php''.

When using the web interface, use the ''Preview'' option to see if any errors were detected in the previewed rows. If you proceed with the upload and there were something wrong detected with a course, it will be ignored.
===Short file example===
uploadcourse.csv:

Note: shortname, fullname, and category are required.

The category field takes the id of the category, with the default category Miscellaneous having id 1. Categories must already exist. If you put a category id that does not exist, you will receive a "Could not resolve category by ID" error during upload preview, and courses in that category will not be created.

<code>
shortname,fullname,category,summary,enrolment_1,enrolment_1_role,enrolment_1_enrolperiod,role_student<br>
courserestored,Course restored,1,a summary,manual,student,1 month,<br>
courserestored2,Course restored 2,1,a summary,,,,<br>
courserestored3,Course restored 3,1,a summary,,,,padawan<br>
courserestored4,Course restored 4,1,"a summary, with comma",manual,student,1 month,padawan<br>
</code>
Notice there are no spaces between the items.

==Creating the text file==
The text file to upload courses must be a CSV file. It accepts the following columns which are divided in two categories, the course information, and the course actions.
===Course information fields===
Most of those settings are available on the settings page of a course. Please refer to [[Course settings]] for more information. Field names must be lower-case.
;shortname
:The shortname
;fullname
:The full name
;idnumber
:The course ID number
;category
:This is the database identifier of the category (found in the category URL) to place the course in. This takes precedence over ''category_idnumber'' and ''category_path''.
;category_idnumber
:The ID number of the category (found and editable on the ‘Edit category’ page) to place the course in. This takes precedence over ''category_path''.
;category_path
:The path of the category to place the course in. If you want to place the course in a category named "Science-Fiction" which is located under the category "Movies", the value to provide is: <code>Movies / Science-Fiction</code>. Note that the separator must be <code>[space]/[space]</code>. Also note that the category MUST exist, it will not be created. If you want to place the course in the top-level category "Movies", the value to provide is: <code>Movies</code>
;visible
:1 if the course is visible, 0 if hidden
; startdate
:The time at which the course starts. Please note that this value is passed to the PHP function [http://php.net/manual/en/function.strtotime.php strtotime] to generate a timestamp. Example 01.12.2014 (1st December 2014)
;enddate
:The time at which the course ends. Please note as with startdate that this value is passed to the PHP function [http://php.net/manual/en/function.strtotime.php strtotime] to generate a timestamp. Example 01.12.2014 (1st December 2014)
;summary
:The summary of the course
;format
:The course format to use, this must be a valid course format plugin name. E.g. ''weeks'', ''topics''.
;theme
:The theme to use
;lang
: The language to use
;newsitems
:The number of news items
;showgrades
:1 to show the gradebook to students, 0 to hide it.
;showreports
:1 to show the activity reports, 0 to hide it.
;legacyfiles
:1 to enable the legacy course files, 0 not to.
; maxbytes
:The maximum upload size of the course in bytes. Use 0 for the site limit.
;groupmode
:0 for ''No groups'', 1 for ''Separate groups'' and 2 for ''Visible groups''.
; groupmodeforce
:1 to force the group mode, otherwise enter 0.
;enablecompletion
:1 to enable the activity completion, 0 not to.
; tags
: A comma-separated list of tags to add to the course. Existing tags will be deleted. Enclose multiple tags in quotes.
====Enrolment fields====
Some fields can be constructed to enable and configure enrolment methods. The fields must be named ''enrolment_[number]'' for the enrolment method name, and ''enrolment_[number]_property'' for its properties.
; enrolment_[number]
:The name of the enrolment method (eg, manual, guest, self)
; enrolment_[number]_delete
:1 to delete this enrolment method from the course, if set to 1 all the other properties will be ignored.
;enrolment_[number]_disable
:1 to disable this enrolment method from the course, if set to 1 all the other properties will be ignored.
;enrolment_[number]_startdate
:The enrolment start date. This value is passed to the PHP function strtotime().
; enrolment_[number]_enddate
:The enrolment end date. This value is passed to the PHP function strtotime().
; enrolment_[number]_enrolperiod
:Number of seconds, or if not a value understood by strtotime() such as "4 days".
; enrolment_[number]_role
:The role short name
;enrolment_[number]_[property]
:Where property is understood by the specified enrolment method
;enrolment_[number]_password
:The course enrolment key
Note: Upload courses is not yet compatible with all [[Enrolments|enrolment methods]] (MDL-43127).

'''Example'''
enrolment_1: manual
enrolment_1_role: student
enrolment_1_enrolperiod: 1 month

enrolment_2: self
enrolment_2_startdate: 2013-01-30
'''Example of a CSV file and a description of the courses it will create'''

First, find or create the category you want to upload your courses into. Click on the category and make a note of the number at the end of the URL. Replace __ below with that number.
shortname,fullname,category,enrolment_1,enrolment_1_password

Course 1,Course 1,__,manual,

Course 2,Course 2,__,self,

Course 3,Course 3,__,self,EnrolMe!
The above will create 3 courses. The course's short name and the course's full name are the same in these instances.

Course 1 has manual enrolment only.

Course 2 has manual enrolment and self-enrolment.

Course 3 has manual enrolment and self-enrolment, and the self-enrolment has an enrolment key which is "EnrolMe!"
====Role renaming====
To rename some roles, using the following pattern:
;role_[shortname]
:The new name of the role ''[shortname]''.
'''Example'''
role_student: Apprentice
role_teacher: Master
role_mycustomrole: Jedi
It is worth noting that the short name for the teacher role is ''editingteacher'' and the short name for the non-editing teacher is ''teacher''.
===Course action fields===
Those settings take precedence over the ''Course process'' parameters.
; delete
:1 to delete the course
;rename
:The shortname to rename the course to
;backupfile
:An absolute path to a backup file (.mbz) to import in the course.
(This means the full path to your course, for example ''/home/yourmoodle/public_html/moodle27/transfert/backup.mbz'' . If you are unsure of this, look at include_path in ''Site administration>Server>PHP info.)''
;templatecourse
:The short name of a course to import the content from
;reset
:1 to reset the course
===Mandatory fields===
;shortname
:This field is mandatory for every operation, with the only exception of creating new courses. See details on the course process parameter ''Shortname template'' for more information.
;fullname
: Required when creating a new course.
;category, category_idnumber, category_path
:One of these is required when creating a course.
===Import options===
To prevent unexpected behaviour, you have to specify what you want the tool to be able to do.
;Upload mode
: This allows you to specify if courses can be created and/or updated.
;Update mode
:If you allow courses to be updated, you also have to tell the tool what to update the courses with.
;Allow deletes
:Whether the ''delete'' field is accepted or not
;Allow renames
:Whether the ''rename'' field is accepted or not
;Allow resets
:Whether the ''reset'' field is accepted or not
===Course process===
This allows you to specify actions to be taken for every course uploaded.
;Shortname template
:If you are creating courses without a shortname, you can use this field to automatically generate a shortname. This field accepts two placeholders: %i for the ID number, %f for the summary.
; Restore file
:A backup file (.mbz) to import in the course after create/update.
;Restore from course
:The shortname of a course to import content from after create/update.
;Reset after upload
:Whether to reset the course after creating/updating it.
===Default course values===
Those are values that can be set in the web interface for all the fields that are not specified in the CSV file. Note that they are always used when creating a course, but only when specified during update (see ''Update mode'').
==Increasing speed==
When importing the content of a backup file, or another course, you are advised to enable the setting ''keeptempdirectoriesonbackup''. This will considerably speed up the process of the upload if you are importing multiple times from the same source.
==See also==
*Demo screencast: [http://youtu.be/MzK2jb-9SwE Bulk course creation]
*[[Upload users]]
*[http://www.moodleblog.net/2013/11/24/creating-course-templates-in-moodle-2-6/ Creating course templates in Moodle 2.6] blog post by Mary Cooch
[[fr:Modifier des cours en lots]]
[[de:Kurse hochladen]]
[[es:Subir cursos]]
[[ja:コースをアップロードする]]

Activities block

2021-04-12T13:08:04Z

Plemaire: change french translation link to match

{{Blocks}}
[[File:Activitiesblockexample.png]]
The '''Activities''' block lists the different activities and resources available in your course ([[Forums]], [[Quizzes]], [[Assignments]], [[Lessons]] and so forth) and provides links to the index page for each activity or resource.

The activities list will grow as you add activities to your course. Therefore, the first time you enter your course, the only category that is listed is Forums. This is because one forum exists by default – the Announcements forum.

[[es:Bloque de actividades]]
[[eu:Jarduerak]]
[[fr:Bloc_Activités]]
[[pl:Blok działalności]]
[[de:Aktivit%C3%A4ten_%28Block%29]]

Server settings

2021-02-20T18:32:56Z

Plemaire: change french translation link to match

{{Managing a Moodle site}}
*[[System paths]]
*[[Session handling]]
*[[HTTP]]
*[[Maintenance mode]]
*[[Cleanup]]
*[[Environment]]
*[[Mail configuration]]
*[[Scheduled tasks]]
*[[Shell Scripts]]

[[fr:Paramètres_du_serveur]]
[[de:Servereinstellungen]]
[[es:Configuraciones del servidor]]
[[it:Impostazioni Server]]

SCORM settings

2021-02-19T11:07:42Z

Plemaire: change french translation link to match

{{SCORM}}
*This page explores in more detail the settings for the [[SCORM activity]] once you have added it to your course and also covers the Site administration settings.
*SCORM packages may also be added by selecting the Single activity course format when setting up a course, and then uploading or dragging/dropping the package. The same settings apply.

Note that if you want to edit an existing SCORM pacakge, click the Edit link to its right and choose the action you wish to take, eg 'Edit settings'.
==General==
In the Description, provide instructions for students. Check the box if you want these instructions to display on the course page.
==Package==
Drag and drop or click the icon top left to upload your SCORM package. (Note that you must not unzip the package before upload.)
:If your admin has added additional options in ''Site administration>Plugins>Activity modules>SCORM package'' then these will be available in a dropdown menu. See the section on Site settings below.

If you access your SCORM package from a repository (such as [[File system repository]] or [[Private files]]) you can choose to create an '''alias/shortcut t'''o it and then set an update frequency to set how often Moodle should check to see if there is an updated zip. (See [[Working with files]] for more information on setting an alias/shortcut.)

It it possible to select the imsmanifest.xml file and have it as an alias/shortcut. To do this, you need to have created a [[File system repository]] and, when configuring it, allowed relative files. Extract your SCORM package into a folder there. When clicking on the Add button to add your SCORM package, select the file system repository folder with your SCORM package and browse for and select the imsmanfest.xml file, ensuring you the option to create an alias/shortcut to the file. Save and display. (Note this method is only currently supported by the File system repository.)

===Appearance===
;Display package
:Choose from current or new window. Note that if you choose a new window, students need to ensure pop ups are enabled.
;Display course structure on entry page
:If this is enabled then the table of contents of the package will be displayed when the students clicks to access the package.
;Show Navigation
:This setting determines whether the navigation buttons are shown or not.
#No -they are hidden
#Under content - they are displayed underneath the SCORM package
#Floating - the navigation buttons are floating (with options to choose the position from the left and top)
;Display attempt status
:You can choose whether to display a summary of the student's attempts on the entry page, on their [[Dashboard]] page or both. This setting is helpful when debugging grading issues - working out why a user got a certain grade.

''The following settings become visible when "Show more" is clicked:''

====Width====
Stage size width as a css value, either % or pixels. Default is 100%. You can change to a different percentage by putting a % symbol after the number (ex. 80%). You can also set to a pixels value by entering a number higher than 100 (ex. 800).
====Height====
Stage size height as a css value, either % or pixels. Default is 500 pixels. You can change to a percentage by putting a % symbol after the number (ex. 80%). You can also set to a pixels value by entering a number higher than 100 (ex. 800).

====Options====
There is a series of check boxes for:Allow the window to be resized ad scrolled, displaying directory links, location bar, menu bar, toolbar and/or status.
*'''Student skip content structure page''' - never, first access, always
*'''Disable preview mode''' - If this option is set to Yes, the Preview button in the view page of a SCORM/AICC Package activity will be hidden. The student can choose to preview (browse mode) the activity or attempt it in the normal mode. When a Learning Object is completed in preview (browse) mode, it's marked with browsed icon
*'''Display course structure in player'''
==Availability==
Choose here the dates you wish the SCORM package to be available to students.
==Grade==
;Grading method
** Learning Objects - This mode shows the number of completed/passed Learning Objects for the activity. The max value is the number of Package's Learning Objects. ''Tip:'' If your SCORM package does report cmi.core.lesson_status, and does not report cmi.core.score.raw, then you should use this setting.
** Highest grade - The grade page will display the highest score obtained by users in all passed Learning Objects. ''Tip:'' If your SCORM package does report cmi.core.score.raw, and does not report cmi.core.lesson_status, then you should use this setting, Average grade, or Sum grade.
** Average grade - If you choose this mode Moodle will calculate the average of all scores.
**Sum grade - With this mode all the scores will be added.
;Maximum grade
:Not applicable if Grading Method is Learning objects. Usual setting is 100. If your SCO 's high score is something other than 100, you should adjust this value appropriately. When grading Method is one of the score settings, then the gradebook grade is package score divided by this number.
==Attempts management==
;Number of attempts
:Defines the number of attempts permitted to users. It works only with SCORM 1.2 and AICC packages. SCORM2004 has its own max attempts definition.
** The option to start a new attempt is provided by a checkbox above the '''Enter''' button on the content structure page, so be sure you're providing access to that page if you want to allow more than one attempt.
** An attempt is not complete until the cmi.core.lesson_status for the attempt is set to either 'completed' or 'passed'. After that, the '''Start new attempt''' checkbox is available to the learner.
;Attempts grading
:When you permit multiple attempts for students, you can choose how to record the result in gradebook by first, last, average or highest settings.
* '''Display attempt status''' - If enabled, scores and grades for attempts are displayed on the SCORM outline page. This setting makes the block display more info to the user on the entry page to the SCORM and in the course overview block - if you turn it off it will display less info. This setting is helpful when debugging grading issues - working out why a user got a certain grade.
;Force new attempt
:If this is enabled then every time the student accesses the package, it will count as a new attempt.
;Lock after final attempt
:If this is enabled then once a student has used up all their attempts, they can no longer access the SCORM package.
==Compatibility settings==
;Auto-continue
:For SCORM packages that contain multiple learning objects (or SCO's) and Auto-continue is set to Yes, when a Learning Object calls the "close communication" method the next available object is launched automatically.If it is set to No, the users must use the navigation provided to continue to the next object. Many SCORM packages only contain a single learning object (or SCO) so this setting does not apply.
:''TIP:'' If your package contains multiple branches Auto-Continue will only move from one object to the next within the same topic.
;Force completed
:If this is enabled then the status of the current attempt is set to "complete". Note that this only applies to SCORM 1.2 packages and is useful if the SCORM package does not handle revisiting an attempt correctly, in review or browse mode, or otherwise incorrectly issues the completion status.
;Auto commit
:Some SCORM packages don't explicitly call Commit() regularly for whatever reason so progress is not stored in the database. This patch will Commit() the data from the SCORM package 60 seconds after the values are set, unless the package Commit()s sooner.
;Mastery score overrides status
:If this setting is enabled and a mastery score is provided within your package, when LMSFinish is called and a raw score has been set, if the raw score is lower than the mastery score, the lesson status will be overridden and set to "failed". More information on this behaviour is available in the [[SCORM_FAQ#Moodle_changes_cmi.core.lesson_status_from_.22completed.22_or_.22passed.22_to_.22failed.22|SCORM FAQ:Moodle changes cmi.core.lesson_status from completed or passed to failed]]

==Other settings==
Depending on what is enabled for your site and course, you may also need to explore [[Common module settings]], [[Restrict access| Restrict access]], [[Activity completion]], [[Tags]] and [[Competencies]]

If your SCORM package doesn't display as you wish, check the site settings below:

==Site administration settings==

These options are available to the site admin via ''Site administration > Plugins > Activity Modules > SCORM Package''.

===Default Value Settings===
Many of the settings available in the SCORM Package administration simply set the default value for the SCORM activity module setup options provided within courses. Edit these settings to save yourself time when adding large numbers of packages, or to establish a standard for presentation across the site.

===Other Important Settings===
The following options provided which '''do not''' simply set a default value for the SCORM activity editing page view.
; Auto-update frequency
If not using a standard SCORM package uploaded using the filepicker and the SCORM package is hosted outside your Moodle installation the option to auto-update the package will be available - you can elect to have the package updated on every entry to the package or daily via the Moodle cron.
;Synchronization time

;Enable SCORM 1.2 standard mode
:If this setting is disabled, then it will be possible to exceed the allowed amount of stored data for SCORM 1.2 packages. Many SCORM packages go over the 4096 characters limit and while SCORM 2004 allows a higher number of characters, it is not supported. This setting will mean users can allow their 1.2 packages to store more data. When disabled it extends the items restricted to 256 and 4096 by the SCORM 1.2 spec to 64000 (the highest value allowed in the SCORM 2004 spec)
;Enable external package type
:If selected, presents a text field to paste a URL to a remote imsmanifest.xml (in an unzipped remote SCORM package), as well as the file picker option provided by default. Note that the content is played from the designated location, and not unpacked into the Moodle file system. So if the base url is different from your moodle url then browser security will block cross-domain communcation and no grades/tracking information will be passed back to Moodle.
;Enable downloaded package type
:If selected, presents a text field to paste a URL to a remote package.zip SCORM package. Package is downloaded and unzipped into the Moodle file system.
;Enable IMS package type
:Enables a package to be selected from within an IMS repository
;Force users to enable JavaScript
:Since the SCORM API uses JavaScript to save data to Moodle, this is a great idea!
;Activate API debug and tracing (set the capture mask with apidebugmask)
:Turns on debugging for SCORM activities. In Moodle 2 you no longer have to also turn on debugging in the developer options.
;API debug capture mask
:.* will debug for admin user only: You can use the mask to enable debugging under certain conditions. For example, if you are logged in using the admin user (username admin) you can set the api mask to: '''admin.*''' Users not logged in as admin will not see the debugging log. The "Default" api mask is '''.*''' which translates roughly to '''everybody'''.
;Enable direct AICC url
:Makes it easier to connect to externally hosted AICC content as the teacher doesn't have to create an AICC package and is able to link directly to the external AICC url.
;Enable external AICC HACP
:The SCORM activity can also support external AICC HACP Communication where the AICC package is hosted on an external content providers site and passes back http requests directly from the external server instead of within the users web browser session - this is disabled by default.
;AICC pass numeric user id

; Protect package downloads.
:This is disabled by default, meaning packages can always be downloaded (eg for offline mobile use.) If this is enabled then only users with the capability course:manageactivities can download the package.

==See also==

* [[:dev:SCORM_schema |SCORM Schema]] for developers

[[de:Lernpaket konfigurieren]]
[[fr:Paramètres_SCORM]]
[[ja:SCORMを追加/編集する]]
[[es:Configuraciones del SCORM]]

Scheduled tasks

2021-02-10T13:41:01Z

Plemaire: change french translation link to match

{{Server settings}}
==Managing scheduled tasks==
An administrator can schedule routine tasks very precisely from ''Administration > Site administration > Server > Scheduled tasks.''

Note that you still need to run the [[Cron|CRON scripts]] (\admin\cli\cron.php or http:\\yoursite\admin\cron.php) at regular intervals. It is recommended that the cron is run every minute.
{|
|-
|[[File:scheduledtasks1.png|thumb|Scheduled tasks]]
|[[File:scheduledtasks2.png|thumb|Editing a scheduled task]]
|}

Clicking the edit icon allows the administrator to specify the minute/hour/day/month or day of the week the task is to be run. It is also possible to reset the task to its default setting or disable it completely.

The column 'Next run' provides information on whether a plugin or a task is disabled (as well as the date that a task will next run).

==Format for scheduling tasks==

When typing into the fields, the format is the same as for Unix cron. Examples are as follows and are according to which field you are editing:

* is every minute, hour, day, month
*/2 is every two minutes, every two hours or every second day
2-10 is every minute between two and ten past the hour or every hour between 2 and 10 am
0 is every Sunday
1 is every Monday or every January
2,5 is the second and 5th of the month, or February and May, or Tuesday and Friday.

==Fail delay==

If you're trying to debug a cron task, you may notice the Fail Delay becomes populated with a number. This is the time in seconds the cron will delay running the task. To sidestep this problem for development purposes, take a look at the Scheduled Tasks section here: [[Administration_via_command_line#Scheduled_tasks]].

==Running individual tasks==

To be able to run individual scheduled tasks via 'Run now' links on the scheduled tasks page, 'Allow 'Run now' for scheduled tasks' (tool_task | enablerunnow) in Site administration / Security / Site security settings should be enabled AND 'Path to PHP CLI' (pathtophp) in Site administration / Server / System paths should be set.

[[File:examplescheduledtasks.png]]

==Tasks running now==
{{New features}}
Currently running tasks may be viewed from Site administration > Server > Tasks >Tasks running now
[[File:TasksRunningNow.png|600px|center]]

==Launching a task from CLI==
You can also launch individual task from Command Line Interface (see [[Administration_via_command_line#Scheduled_tasks|Administration via command line]]).

[[es:Trabajos agendados]]
[[de:Geplante Vorgänge]]
[[fr:Tâches programmées]]

Administration via command line

2020-08-20T10:51:12Z

Plemaire: /* Get and set configuration values */ more specifics examples

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

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

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

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

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

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

== Upgrading ==

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

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

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

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

== Installation ==

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

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

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

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

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

== Maintenance mode ==

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

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

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

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

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

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

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

== Offline mode ==

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

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

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

== Custom site defaults ==

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

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

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

== Reset user password ==

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

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

== MySQL storage engine conversion ==

If you run your Moodle site with MySQL database backend and use the default MyISAM as the storage engine for your tables, you may want to convert them to use some more reliable engine like InnoDB (actually, you should want to switch to PostgreSQL ;-) anyway).

$ sudo -u apache /usr/bin/php admin/cli/mysql_engine.php --engine=InnoDB

==Converting InnoDB tables to Barracuda==

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

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

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

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

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

===Tool for converting tables===

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

To view tables requiring conversion, use the list option:

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

Here is an example output:

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

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

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

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

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

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

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

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

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

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

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

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

== Running cron via command line ==

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

== Scheduled tasks ==

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

This script accepts the following arguments:

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

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

--showsql - Shows sql queries before they are execute

--showdebugging - Shows developer debugging info

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

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

will return something like:

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

...
</pre>

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

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

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

==Database transfer==

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

==Purge caches==

You can purge caches using this script:

php admin/cli/purge_caches.php

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

php admin/cli/kill_all_sessions.php

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

==Fix course / module sequences==

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

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

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

==Fix orphaned question categories==

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

==Search and replace text==

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

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

==Build theme CSS cache==

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

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

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

==Get and set configuration values==

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

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

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

==See also==

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

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

Administration via command line

2020-08-02T17:58:59Z

Plemaire: /* Installation */

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

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

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

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

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

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

== Upgrading ==

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

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

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

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

== Installation ==

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

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

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

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

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

== Maintenance mode ==

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

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

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

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

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

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

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

== Offline mode ==

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

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

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

== Custom site defaults ==

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

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

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

== Reset user password ==

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

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

== MySQL storage engine conversion ==

If you run your Moodle site with MySQL database backend and use the default MyISAM as the storage engine for your tables, you may want to convert them to use some more reliable engine like InnoDB (actually, you should want to switch to PostgreSQL ;-) anyway).

$ sudo -u apache /usr/bin/php admin/cli/mysql_engine.php --engine=InnoDB

==Converting InnoDB tables to Barracuda==

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

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

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

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

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

===Tool for converting tables===

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

To view tables requiring conversion, use the list option:

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

Here is an example output:

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

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

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

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

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

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

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

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

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

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

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

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

== Running cron via command line ==

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

== Scheduled tasks ==

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

This script accepts the following arguments:

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

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

--showsql - Shows sql queries before they are execute

--showdebugging - Shows developer debugging info

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

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

will return something like:

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

...
</pre>

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

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

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

==Database transfer==

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

==Purge caches==

You can purge caches using this script:

php admin/cli/purge_caches.php

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

php admin/cli/kill_all_sessions.php

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

==Fix course / module sequences==

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

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

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

==Fix orphaned question categories==

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

==Search and replace text==

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

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

==Build theme CSS cache==

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

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

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

==See also==

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

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

Marking guide

2019-04-19T10:05:08Z

Plemaire: FR link rectified

{{Advanced grading methods}}
A marking guide (in the US 'grading guide') is an [[Advanced grading methods|advanced grading method]] where a teacher enters a comment per criterion and a mark up to a maximum.

==Selecting Marking guide==
*Create an assignment, and in the ''Grades'' section, choose from the ''Grading method'' drop down menu the ''Marking guide'' option:

[[File:markinguidelocation.png]]

==Creating a new Marking guide==
*When the assignment has been created and Marking guide selected as above, click ''Save and display'' and choose ''Define new grading form from scratch''
*(See section 5 for information on how to use a template.)

[[File:markinguidefromscratch.png]]

*Give the guide a name and description.
*Click ''on'' the criterion name to edit it. It will open up a box for typing into.
*Click the ''Click to edit'' links to provide an explanation for students and for markers as to what is required. It will open up a box for typing into.
*Click the ''Click to edit'' link to allocate a maximum mark for this criterion. It will open up a box for typing into.

[[File:clickhereguide.png]]

===Adding more criteria===
*Click the button to add one or more criteria (and then repeat the process as above)

[[File:markinguidemorecriteria.png]]

===Adding frequently used comments===
*If a teacher regularly uses the same comments when marking, it is possible to add these to a ''frequently used comments'' bank.
*Click the ''Click to edit'' link and add a comment.
*Click the ''+Add frequently used comment'' button to add another one and repeat as needed:

[[File:frequentcomments1.png]]

===Marking guide options===
*By checking the appropriate boxes it is possible to allow students to see (or not)the guide definition and how many marks are allocated per criterion.

==Saving and using Marking guide==
*Once completed, the guide may be saved as a draft or saved and made ready to use, according to the button selected at the bottom of the screen.

==Editing or deleting Marking guide==
*Once completed, a guide may be edited or deleted by going to ''Settings>Assignment administration>Advanced grading>Marking guide.'' Options appear to edit or delete the currently defined form.
*When an assignment has been graded, a warning appears if the guide is edited to check whether the assignments need to be regraded or not.

{|
| [[File:editdelete.png|thumb|Editing or deleting Marking guide]]
| [[File:markforregrade.png|thumb|Alert about regrading]]
|}

==Using templates==
*Those users with the capability [[Capabilities/moodle/grade:sharegradingforms]] (and perhaps [[Capabilities/moodle/grade:managesharedforms]]) may save their forms as a template for others to use. They will see an additional option in ''Settings>Assignment administration>Advanced grading''

[[File:markingtemplate.png]]

''(Note that teachers do not have these capabilities by default.'')

*If templates have been made available, then on first accessing the Marking guide, teachers may select to "Create a new grading form from a template". This will open up a search box to locate the desired template:

[[File:gradingformsearch.png]]

==Duplicating the Marking guide==
Note that when duplicating or restoring a Marking guide, frequently used comments will be duplicated only from from Moodle 2.6.2 onwards. Prior to this version they were not copied over.

==Marking assignments==
*When the assignment to be graded is accessed in the usual way, the form appears with the criteria and an empty comments and score box. If frequently used comments have been added, the teacherclicks into the box and then clicks on the required comment to insert it:

[[File:markingwithmarkingguide.png]]

==How students view the marking guide==

When students click on an assignment which has a marking guide attached to it, they will see the marking guide as part of the information about their assignment. Thus, they can see the marking guide before they submit.

{|
|[[File:markingguidebeforesubmission.png|thumb|Student view of marking guide on assignment grading screen]]
|}

==See also==

*[http://school.demo.moodle.net/grade/grading/manage.php?areaid=30 School demo example of teacher view of Marking guide ready for usage] (Log in as username '''teacher'''/password '''moodle''')
*[http://school.demo.moodle.net/grade/grading/form/guide/preview.php?areaid=30 School demo example of student view of Marking guide to help with assignment] (Log in as username '''student'''/password '''moodle''')

[[de:Bewertungsrichtlinien]]
[[es:Guía de puntaje]]
[[fr:Guide_d%27évaluation]]

Course reports

2019-04-18T14:16:27Z

Plemaire: FR link rectified

{{Tracking progress}}

{{MediaPlayer | url = https://youtu.be/VR91YcB3tCw | desc = Course reports}}

* [[Competency breakdown report]]
* [[Logs]]
* [[Activity report]]
* [[Participation report]]
* [[Statistics]]
* [[Event monitoring]]

==See also==

* [[Site-wide reports]] in Managing a Moodle site
* [[Learning analytics]]

[[es:Reportes del curso]]
[[de:Kursberichte]]
[[fr:Rapports du cours]]

Site-wide reports

2019-04-18T13:46:27Z

Plemaire: Add FR link

{{Managing a Moodle site}}
==Standard reports for administrators==
In addition to reports available at both site and course level, the following site-wide reports are available for administrators:

* [[Config changes report|Config changes]] - Shows changes made by an administrator to the site configuration
* [[Course overview report|Course overview]]
* [[Events list report|Events list]]
* [[Question instances report|Question instances]] - Reports where particular question types are used on the site
* [[admin/comment/index#Comments_report|Comments]] - See all comments created on the site.
* [[admin/report/backups/index#Backups_report|Backups]] - displays a list of all course backups made, the time taken to create them, their status, and the next scheduled automated backup execution time
* [[Logs]] - Activity reports for course or site
* [[admin/report/loglive/index#Live_logs_from_the_past_hour|Live Logs]] - Live logs from the past hour as a table
* [[Performance_overview|Performance overview]] - overview of settings that may impact site performance such as Theme Designer Mode or Debugging
* [[admin/report/security/index|Security overview]] - overview of security related settings such as Allowing EMBED and OBJECT tags or No Authentication.
* [[admin/tool/spamcleaner/index#Cleaning_up_spam|Spam cleaner]] - helpful tool for rooting out spam users if you do not have [[Email-based_self-registration#Enable_reCAPTCHA_element|Captcha]] required as part of authentication.

==See also==

*[[Browser sessions]]
*[[Reports FAQ]]
*[[Course reports]] in Managing a Moodle course
*[[Plugins_overview| Plugins overview]] for checking the status of all plugins on the site.
*[[:dev:General report plugins|General report plugins]] developer documentation
*[[ad-hoc contributed reports]]

[[Category:Report]]

[[es:Reportes del sitio]]
[[de:Systemweite Berichte]]
[[it:Report a livello di sito]]
[[fr:Rapports de site]]

Upload courses

2019-04-17T17:14:57Z

Plemaire: Link for FR

{{Courses}}
{{Note|This page is about creating courses with a text (.csv) file. If you want to upload a course backup in .mbz or .tgz format, see [[Course restore]].}}

==Upload courses==

In addition to creating new courses, the upload courses functionality may also be used to update or delete courses, or import content from another course. For information on using this functionality to create course templates, see [[Adding a new course]].

To upload one or more courses

# Go to ''Administration > Site administration > Courses > Upload courses''
# Either drag and drop the CSV file or click the 'Choose a file' button and select the file in the file picker
# Select appropriate import options carefully, then click the preview button.

{|
|[[File:26uploadcourses.png|250px|thumb|Upload courses admin screen]]
|
|[[File:uploadcoursesresults.png|250px|thumb|Courses successfully uploaded]]
|}

Note: It is also possible to use the command-line tool ''admin/tool/uploadcourse/cli/uploadcourse.php''.

When using the web interface, use the ''Preview'' option to see if any errors were detected in the previewed rows. If you proceed with the upload and there were something wrong detected with a course, it will be ignored.

=== Short file example ===
uploadcourse.csv:

Note: shortname, fullname, and category are required.

The category field takes the id of the category, with the default category Miscellaneous having id 1. Categories must already exist. If you put a category id that does not exist, you will receive a "Could not resolve category by ID" error during upload preview, and courses in that category will not be created.

<code bash>
shortname,fullname,category,summary,enrolment_1,enrolment_1_role,enrolment_1_enrolperiod,role_student
courserestored,Course restored,1,a summary,manual,student,1 month,
courserestored2,Course restored 2,1,a summary,,,,
courserestored3,Course restored 3,1,a summary,,,,padawan
courserestored4,Course restored 4,1,"a summary, with comma",manual,student,1 month,padawan
</code>
Notice there are no spaces between the items.

==Creating the text file==

The text file to upload courses must be a CSV file. It accepts the following columns which are divided in two categories, the course information, and the course actions.

===Course information fields===

Most of those settings are available on the settings page of a course. Please refer to [[Course settings]] for more information. Field names must be lower-case.

;shortname
: The shortname
;fullname
: The full name
;idnumber
: The ID number (found on the ‘Edit Category’ page)
;category
: This is the ID of the category to place the course in. This takes precedence over ''category_idnumber'' and ''category_path''.
;category_idnumber
: The ID number of the category to place the course in (found in the category url). This takes precedence over ''category_path''.
;category_path
: The path of the category to place the course in. If you want to place the course in a category named "Science-Fiction" which is located under the category "Movies", the value to provide is: <code>Movies / Science-Fiction</code>. Note that the separator must be <code>[space]/[space]</code>. Also note that the category MUST exist, it will not be created. If you want to place the course in the top-level category "Movies", the value to provide is: <code>Movies</code>
;visible
: 1 if the course is visible, 0 if hidden
;startdate
: The time at which the course starts. Please note that this value is passed to the PHP function [http://php.net/manual/en/function.strtotime.php strtotime] to generate a timestamp. Example 01.12.2014 (1st December 2014)
;enddate
: The time at which the course ends. Please note as with startdate that this value is passed to the PHP function [http://php.net/manual/en/function.strtotime.php strtotime] to generate a timestamp. Example 01.12.2014 (1st December 2014)
;summary
: The summary of the course
;format
: The course format to use, this must be a valid course format plugin name. E.g. ''weeks'', ''topics''.
;theme
: The theme to use
;lang
: The language to use
;newsitems
: The number of news items
;showgrades
: 1 to show the gradebook to students, 0 to hide it.
;showreports
: 1 to show the activity reports, 0 to hide it.
;legacyfiles
: 1 to enable the legacy course files, 0 not to.
;maxbytes
: The maximum upload size of the course in bytes. Use 0 for the site limit.
;groupmode
: 0 for ''No groups'', 1 for ''Separate groups'' and 2 for ''Visible groups''.
;groupmodeforce
: 1 to force the group mode, otherwise enter 0.
;enablecompletion
: 1 to enable the activity completion, 0 not to.
;tags
: A comma-separated list of tags to add to the course. Existing tags will be deleted. Enclose multiple tags in quotes.

====Enrolment fields====

Some fields can be constructed to enable and configure enrolment methods. The fields must be named ''enrolment_[number]'' for the enrolment method name, and ''enrolment_[number]_property'' for its properties.

;enrolment_[number]
: The name of the enrolment method (eg, manual, guest, self)
;enrolment_[number]_delete
: 1 to delete this enrolment method from the course, if set to 1 all the other properties will be ignored.
;enrolment_[number]_disable
: 1 to disable this enrolment method from the course, if set to 1 all the other properties will be ignored.
;enrolment_[number]_startdate
: The enrolment start date. This value is passed to the PHP function strtotime().
;enrolment_[number]_enddate
: The enrolment end date. This value is passed to the PHP function strtotime().
;enrolment_[number]_enrolperiod
: Number of seconds, or if not a value understood by strtotime() such as "4 days".
;enrolment_[number]_role
: The role short name
;enrolment_[number]_[property]
: Where property is understood by the specified enrolment method
;enrolment_[number]_password
: The course enrolment key

Note: Upload courses is not yet compatible with all [[Enrolments|enrolment methods]] (MDL-43127).

'''Example'''

enrolment_1: manual
enrolment_1_role: student
enrolment_1_enrolperiod: 1 month

enrolment_2: self
enrolment_2_startdate: 2013-01-30

====Role renaming====

To rename some roles, using the following pattern:

;role_[shortname]
: The new name of the role ''[shortname]''.

'''Example'''

role_student: Apprentice
role_teacher: Master
role_mycustomrole: Jedi

It is worth noting that the short name for the teacher role is ''editingteacher'' and the short name for the non-editing teacher is ''teacher''.

===Course action fields===

Those settings take precedence over the ''Course process'' parameters.

;delete
: 1 to delete the course
;rename
: The shortname to rename the course to
;backupfile
: An absolute path to a backup file (.mbz) to import in the course.

(This means the full path to your course, for example ''/home/yourmoodle/public_html/moodle27/transfert/backup.mbz'' . If you are unsure of this, look at include_path in ''Site administration>Server>PHP info.)''
;templatecourse
: The short name of a course to import the content from
;reset
: 1 to reset the course

===Mandatory fields===

;shortname
: This field is mandatory for every operation, with the only exception of creating new courses. See details on the course process parameter ''Shortname template'' for more information.
;fullname
: Required when creating a new course.
;category, category_idnumber, category_path
: One of these is required when creating a course.

===Import options===

To prevent unexpected behaviour, you have to specify what you want the tool to be able to do.

;Upload mode
: This allows you to specify if courses can be created and/or updated.
;Update mode
: If you allow courses to be updated, you also have to tell the tool what to update the courses with.
;Allow deletes
: Whether the ''delete'' field is accepted or not
;Allow renames
: Whether the ''rename'' field is accepted or not
;Allow resets
: Whether the ''reset'' field is accepted or not

===Course process===

This allows you to specify actions to be taken for every course uploaded.

;Shortname template
: If you are creating courses without a shortname, you can use this field to automatically generate a shortname. This field accepts two placeholders: %i for the ID number, %f for the summary.
;Restore file
: A backup file (.mbz) to import in the course after create/update.
;Restore from course
: The shortname of a course to import content from after create/update.
;Reset after upload
: Whether to reset the course after creating/updating it.

===Default course values===

Those are values that can be set in the web interface for all the fields that are not specified in the CSV file. Note that they are always used when creating a course, but only when specified during update (see ''Update mode'').

==Increasing speed==

When importing the content of a backup file, or another course, you are advised to enable the setting ''keeptempdirectoriesonbackup''. This will considerably speed up the process of the upload if you are importing multiple times from the same source.

==See also==

* Demo screencast: [http://youtu.be/MzK2jb-9SwE Bulk course creation]
* [[Upload users]]
* [http://www.moodleblog.net/2013/11/24/creating-course-templates-in-moodle-2-6/ Creating course templates in Moodle 2.6] blog post by Mary Cooch

[[fr:Modifier des cours en lots]]
[[de:Kurse hochladen]]
[[es:Subir cursos]]
[[ja:コースをアップロードする]]

Scheduled tasks

2019-04-14T07:43:01Z

Plemaire: add cli link

{{Server settings}}
An administrator can schedule routine tasks very precisely from ''Administration > Site administration > Server > Scheduled tasks.''

Note that you still need to run the [[Cron|CRON scripts]] (\admin\cli\cron.php or http:\\yoursite\admin\cron.php) at regular intervals. It is recommended that the cron is run every minute.
{|
|-
|[[File:scheduledtasks1.png|thumb|Scheduled tasks]]
|[[File:scheduledtasks2.png|thumb|Editing a scheduled task]]
|}

Clicking the edit icon allows the administrator to specify the minute/hour/day/month or day of the week the task is to be run. It is also possible to reset the task to its default setting or disable it completely.

The column 'Next run' provides information on whether a plugin or a task is disabled (as well as the date that a task will next run).

==Format for scheduling tasks==

When typing into the fields, the format is the same as for Unix cron. Examples are as follows and are according to which field you are editing:

* is every minute, hour, day, month
*/2 is every two minutes, every two hours or every second day
2-10 is every minute between two and ten past the hour or every hour between 2 and 10 am
0 is every Sunday
1 is every Monday or every January
2,5 is the second and 5th of the month, or February and May, or Tuesday and Friday.

==Fail delay==

If you're trying to debug a cron task, you may notice the Fail Delay becomes populated with a number. This is the time in seconds the cron will delay running the task. To sidestep this problem for development purposes, take a look at the Scheduled Tasks section here: [[Administration_via_command_line#Scheduled_tasks]].

==Running individual tasks==

To be able to run individual scheduled tasks via 'Run now' links on the scheduled tasks page, 'Allow 'Run now' for scheduled tasks' (tool_task | enablerunnow) in Site administration / Security / Site security settings should be enabled AND (new in 3.6 onwards) 'Path to PHP CLI' (pathtophp) in Site administration / Server / System paths should be set.

[[File:examplescheduledtasks.png]]

===Launching a task from CLI===
You can also launch individual task from Command Line Interface (see [[Administration_via_command_line#Scheduled_tasks|Administration via command line]]).

[[es:Trabajos agendados]]
[[de:Geplante Vorgänge]]

Marking guide

2019-04-08T07:21:26Z

Plemaire:

admin/environment/php setting/file uploads

2018-06-15T11:49:30Z

Plemaire:

{{Environment}}
''file_uploads'' needs to be activated (ON).

[[Category:Environment|PHP]]

[[es:admin/environment/php setting/file uploads]]

Filters FAQ

2018-03-09T14:31:59Z

Plemaire: /* Why is my filter not working? */

{{Filters}}
== What are filters? ==

Filters allow for the automatic transformation of entered text into different, often more complex forms. For example the titles of resources can automatically become hyperlinks that take you to the relevant resource, URLs pointing to mp3 files can become Flash controls embedded in the web page that let you pause and rewind the audio. The possibilities are endless and there are a number of standard filters included with Moodle and many more specialized filters available from the Moodle.org Modules and plugins database.

See [[Filters]] for details.

== How do I enable filters? ==

You find the settings under ''Administration > Site administration > Plugins > Filters > Manage filters'', see [[Managing filters]] for details.

==Why is my filter not working?==

After checking that the filter is enabled for the site, course and activity or resource, go to ''Site administration > Plugins > Filters > Manage filters'' and try moving the filter higher up the list. See the forum discussion [http://moodle.org/mod/forum/discuss.php?d=194684 Moodle Media player not appearing] for an example.

If you have enabled the automatic URL conversion filter but do not see the result in forum posts or on a page resource, you will need to enable HTML content in "filter_urltolink | formats".

== Where do I find additional filters? ==

You will find a number of contributed filters in the [http://moodle.org/plugins/browse.php?list=category&id=7 Moodle Plugins directory].

== How do I create custom filters? ==

See the following developer docs for details:
* [[:dev:Filters]]
* [[:dev:Filters schema]]
* [[:dev:Filters 2.0]]

== See also ==

* [[Filters used on the Moodle.org forums]]

[[Category:FAQ]]

[[de:Filter FAQ]]

Filters FAQ

2018-03-09T14:31:28Z

Plemaire: /* Why is my filter not working? */

{{Filters}}
== What are filters? ==

Filters allow for the automatic transformation of entered text into different, often more complex forms. For example the titles of resources can automatically become hyperlinks that take you to the relevant resource, URLs pointing to mp3 files can become Flash controls embedded in the web page that let you pause and rewind the audio. The possibilities are endless and there are a number of standard filters included with Moodle and many more specialized filters available from the Moodle.org Modules and plugins database.

See [[Filters]] for details.

== How do I enable filters? ==

You find the settings under ''Administration > Site administration > Plugins > Filters > Manage filters'', see [[Managing filters]] for details.

==Why is my filter not working?==

After checking that the filter is enabled for the site, course and activity or resource, go to ''Site administration > Plugins > Filters > Manage filters'' and try moving the filter higher up the list. See the forum discussion [http://moodle.org/mod/forum/discuss.php?d=194684 Moodle Media player not appearing] for an example.
If you have enabled the automatic URL conversion filter but do not see the result in forum posts or on a page resource, you will need to enable HTML content in "filter_urltolink | formats".

== Where do I find additional filters? ==

You will find a number of contributed filters in the [http://moodle.org/plugins/browse.php?list=category&id=7 Moodle Plugins directory].

== How do I create custom filters? ==

See the following developer docs for details:
* [[:dev:Filters]]
* [[:dev:Filters schema]]
* [[:dev:Filters 2.0]]

== See also ==

* [[Filters used on the Moodle.org forums]]

[[Category:FAQ]]

[[de:Filter FAQ]]

Git for Administrators

2015-08-29T16:11:51Z

Plemaire:

{{Installing Moodle}}
This page describes how to maintain a copy of Moodle on your production server which can easily be upgraded using Git. If you have customisations of Moodle core code, you are advised to follow the instructions in the [[:dev:Git for developers|Git for developers guide]].

To get the most of Git it is worth making the effort to understand its basic concepts - see the section below. It can be a bit of a steep learning curve, especially if you are used to CVS or Subversion.

== Getting hold of Git (Windows, OSX, Linux and others) ==

Support for Git was, up until recently, mostly confined to Linux but builds are now available for most popular operating systems:

* List of downloads from Git site - http://git-scm.com/download

Once you have downloaded and installed your OS relevant git installation, the git commands in this document should work with your operating system.

== Obtaining the code from Git ==

The command line version of Git is discussed here. Graphical clients are little more than wrappers around the command line version, so you should be able to deduce the correct parameters quite easily.

You can find the official Moodle git repository at git://git.moodle.org/moodle.git (with an official clone at git://github.com/moodle/moodle.git). To initialize your local checkout, use
<pre>
$ cd /path/to/your/webroot
$ git clone git://git.moodle.org/moodle.git (1)
$ cd moodle
$ git branch -a (2)
$ git branch --track MOODLE_29_STABLE origin/MOODLE_29_STABLE (3)
$ git checkout MOODLE_29_STABLE (4)
</pre>
* The command (1) initializes the new local repository as a clone of the 'upstream' (i.e. the remote server based) moodle.git repository. The upstream repository is called 'origin' by default. It creates a new directory named ''moodle'', where it downloads all the files. This operation can take a while as it is actually getting the entire history of all Moodle versions
* The command (2) lists all available branches.
* Use the command (3) to create a new local branch called MOODLE_29_STABLE and set it to track the remote branch MOODLE_29_STABLE from the upstream repository.
* The command (4) actually switches to the newly created local branch.

Note that Git has a huge number of options for each command and it's actually possible to do the above process with a single command (left as an exercise!!).

==Git from behind a firewall==

Git uses a read-only protocol that may be blocked by your firewall (port 9418). If this is a problem, you can use Github's http version <nowiki>https://github.com/moodle/moodle.git</nowiki>. It's a bit slower, so use the Git protocol if you can.

== Updating your installation ==

The Moodle development team performs integration and testing of fixed bugs every Monday and Tuesday. On Wednesday you can install all patches by updating your code. Check the [http://git.moodle.org/gw?p=moodle.git;a=summary shortlog] to see if the official repository has been already updated or not.

To update your code to the latest version (on the MOODLE_29_STABLE branch) '''all''' you have to do is:
<pre>
$ cd /path/to/your/moodle/
$ git pull
</pre>
If this is a production site you should still consider the [[Upgrade]] instructions (e.g. take backups).

== Installing a contributed extension from its Git repository ==

This is one way to handle adding plugins from other Git repositories into your Moodle repository. Another way is to use Git Submodules. However, at the time of writing, this is one of Git's rougher features and should be regarded as an advanced option.

For example, let us say we want to install the [[Certificate module]] from its Git repository into our Moodle 2.9.
<pre>
$ cd /path/to/your/moodle/
$ cd mod (1)
$ git clone https://github.com/markn86/moodle-mod_certificate.git certificate (2)
$ cd certificate
$ git checkout -b MOODLE_29_STABLE origin/MOODLE_29_STABLE (3)
$ git branch -d master (4)
</pre>
The command (1) changes the current directory into the ''mod'' folder of your local Moodle clone. The command (2) creates a new subdirectory ''certificate'' and makes a local clone of vanilla Certificate repository. The command (3) creates a new local branch that will track the remote branch with a Certificate version for Moodle 2.9. The command (4) deletes the ''master'' that was created automatically by git-clone in (2) as we do not want it in this production checkout.

Note: you should check first the compatibility of a module with your Moodle branch by asking directly to the Maintainer before cloning the repo or - if you want to guess it - by issuing the command below before running the command (3), in order to verify what is available among the branches:
<pre>
$ git branch -a
* master
remotes/origin/HEAD -> origin/master
remotes/origin/MOODLE_20_STABLE
remotes/origin/MOODLE_21_STABLE
remotes/origin/MOODLE_22_STABLE
remotes/origin/MOODLE_23_STABLE
remotes/origin/MOODLE_24_STABLE
remotes/origin/MOODLE_25_STABLE
remotes/origin/MOODLE_26_STABLE
remotes/origin/MOODLE_27_STABLE
remotes/origin/MOODLE_28_STABLE
remotes/origin/MOODLE_29_STABLE
remotes/origin/master
</pre>
This will avoid an error message when you issue the command (3) against a nonexistent branch, e.g.:
<pre>
§ git checkout -b MOODLE_29_STABLE origin/MOODLE_29_STABLE
fatal: git checkout: updating paths is incompatible with switching branches.
Did you intend to checkout 'origin/MOODLE_29_STABLE' which can not be resolved as commit?
</pre>

Now it is wise to put the new directory mod/certificate/ to the list of ignored files of the main Moodle clone, otherwise a status of the main clone will keep reminding you that the new code has not been checked in.
<pre>
$ cd /path/to/your/moodle/
$ echo /mod/certificate/ >> .git/info/exclude
</pre>
To update your Moodle installation now, you must visit both Git repositories and pull changes from upstream.
<pre>
$ cd /path/to/your/moodle/
$ git pull
$ cd mod/certificate
$ git pull
</pre>
Writing a shell script with these lines in the root of Moodle installation is a very good idea. Otherwise it is easy to forget what Git repositories are there within the main Moodle repository.

== See also ==

; Moodle Docs
* [[Git FAQ]]
* [[Windows installation using Git]]
* [[Git for Mac]]
* [[:dev:Moodle versions]]
* For some screenshots see [[User:Frank_Ralf/Git]] (still work in progress)
* For fixing a Tracker Issue (MDL) / Forking Moodle / CONTRIButing code https://docs.moodle.org/en/User:Sam_Hemelryk/My_Moodle_Git_workflow
* [[Moodle_Production_Server_with_GIT|Case study Git + Moodle from Technical University Berlin]]

; Moodle forum discussions
* [https://moodle.org/mod/forum/discuss.php?d=255175 Github and Moodle deployment for production]
* [https://moodle.org/mod/forum/discuss.php?d=213695 Got GIT installed on my site- here's how!]
* [http://moodle.org/mod/forum/discuss.php?d=168094 GIT help needed]
* [http://moodle.org/mod/forum/discuss.php?d=165236 Best way to manage CONTRIB code with GIT]
* [http://moodle.org/mod/forum/discuss.php?d=167063 Handy Git tip for tracking 3rd-party modules and plugins]
* [http://moodle.org/mod/forum/discuss.php?d=167730 Moodle Git repositories]
* [http://moodle.org/mod/forum/discuss.php?d=183693 Git and CVS]
* [http://moodle.org/mod/forum/discuss.php?d=208904 GIT for dummies]
* [http://moodle.org/mod/forum/discuss.php?d=211930 Git and upgrading misunderstanding]
* [https://moodle.org/mod/forum/discuss.php?d=231046 Clear git guide for Admins (not developers)]

; External resources
* [http://thamblings.blogspot.com.au/2013/07/upgrading-moodle-from-git.html Deploying Moodle from git - Blog post from a production experience]
* [http://www.kernel.org/pub/software/scm/git/docs/everyday.html Everyday GIT With 20 Commands Or So]
* [http://gitref.org/ Git Reference]
* [http://progit.org/book/ Pro Git book]
* [http://eigenjoy.com/2008/05/15/git-from-the-bottom-up/ Git from the bottom up]

[[ja:管理者用Git]]
[[fr:Git_pour_administrateurs]]
[[es:Git para Administradores]]

Upgrading

2010-03-31T17:03:13Z

Plemaire: /* SQL database */

Moodle is designed to upgrade cleanly from one version to the next. Please refer to [[Upgrading to Moodle 1.6]], [[Upgrading to Moodle 1.8]] or [[Upgrading to Moodle 1.9]] for particular considerations related to the upgraded version.

Changes that have been made to the original code, such as installing a contributed module (non-standard module) or a site edit of a php file, may not upgrade. This includes modifications to standard themes that might be overwritten during an upgrade.

* For those using cpanel, you can use [http://ic.eflclasses.org/tutorials/howtoupgrademoodlewithcpanel.swf this tutorial]. It is a bit rough around the edges and is a little dated, but you should get the idea.

* For those who have installed the package version of Moodle using an Ubuntu/Kubuntu/Debian package manager, upgrade instructions can be found [[Ubuntu_Debian_Upgrades|here]].

__TOC__

When upgrading a Moodle installation you should follow these steps:

==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 ''Administration > Server > [[Environment]]''.

== Backup important data ==
There are three areas that need backing up:
#Moodle software directory/folder (For example, everything in server/htdocs/moodle)
#Moodle data (For example, server/moodledata)
#Moodle SQL 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 issue.

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

=== Moodle software directory ===
Make a separate copy of these files before the upgrade, so that you can retrieve your config.php and any modules you have added like themes, and languages.

The best way is to rename the current Moodle directory to something else, then unpack the new Moodle archive into the old location.

=== Moodle data directory ===
The default name for this folder is moodledata. This is where uploaded content resides (such as course resources and student assignments). It is very important to have a backup of these files on a regular basis as a best practice. Sometimes upgrades may move or rename directories within your data directory.

In Linux you can use the cp (copy) command to make a temporary copy of the moodledata. example:
====Linux====
mkdir /var/www/moodledata_backup
cp -r /var/www/moodledata/* /var/www/moodledata_backup

=== SQL database ===
Most Moodle upgrades will alter the SQL database tables, adding or changing fields. Each SQL server program (for example,MySQL, Postgresql, Oracle) has different ways to backup. In a MySQL server, one way of backing up is to 'dump' it to a single SQL file. The following example shows Unix commands to dump the database called "moodle":

mysqldump -u username -p -C -Q -e --create-options moodle > moodle-backup-2007-04-01.sql

Substitute your database user account for username. The -p flag will prompt you for the password for the username specified by -u.

If your database host is different from the host you want to execute the backup command (usually the web server), you have to specify it with the -h option to mysqldump:

mysqldump -u username -p -h databasehost -C -Q -e --create-options moodle > moodle-backup-2007-04-01.sql

You can also use the "Export" feature in Moodle's optional "MySQL Admin" web interface to do the same thing on all platforms. In Moodle v1.9 and greater, this is located in '''Site Administration''' -> '''Server''' -> '''Database'''. This interface can also be downloaded from http://moodle.org/mod/data/view.php?d=13&rid=448. It is an integration of PHPMyAdmin for the Moodle administration interface.

==== SQL dump caveats ====
There are a '''MANY''' options possible for mysqldump.
*Please talk with your Systems Administrator (if you have one) or similar to see if there are site-specific flags you should use for your SQL dump.
** For example, if your local installation is running MySQL 5.2 and you are moving to a system running MySQL 5.0 or 4.1, you really ought to use the "--compat=mysql40" flag. (This is not too uncommon of a situation given the nature of ISP hosting as compared to local user Moodle setups)
* This seems obvious, but should be said outright: These instructions only work for dumping from MySQL! Postgresql, Oracle, and other database servers have different tools to dump databases.
* Given the example mysql import lines, above, you really should use the --no-create-db flag. If your database locally is named something differently from the migration site, not including this flag could cause problems.

== 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 1.x.1 to 1.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.
*Unzip or unpack the upgrade file so that all the Moodle software program files are overwritten on the server. Moodle will adjust SQL and moodledata if it needs to in the upgrade.
*Use the notification link in the site administration to start the upgrade process. You will see a series of lines indicating progress.
*After a successful upgrade, turn off the maintenance mode for your users.

=== Using a downloaded archive ===
*Do not overwrite an old installation unless you know what you are doing ... sometimes old files can cause problems in new installations. The best way is to rename the current Moodle directory to something else, then unpack the new Moodle archive into the old location.

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

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

sudo chown www-data moodle/config.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 ===

You can use CVS for updating or upgrading your Moodle.
First you need to do a CVS checkout in your (empty) Moodle root directory.

You can use any of our [[CVS_for_Administrators#CVS_Servers|CVS Mirror servers]]. Just replace '''SERVER.cvs.moodle.org''' in the instructions below with the name of the mirror server you chose!.

====For Linux servers====

To do a CVS checkout of Moodle, you first have to logon to the Moodle CVS server.

<nowiki>cvs -d:pserver:anonymous@SERVER.cvs.moodle.org:/cvsroot/moodle login</nowiki>
No password for anonymous, so just hit the Enter button.

Go to the directory where you want the Moodle root to come and type

<nowiki>cvs -z3 -d:pserver:anonymous@SERVER.cvs.moodle.org:/cvsroot/moodle co -r MOODLE_18_STABLE moodle</nowiki>
(where MOODLE_18_STABLE is the desired version)

To update, just go into the Moodle root directory and update to the new files:

cvs update -dP
To update to a new version type in the following and change 18 to whatever newest version upgrade number is
cvs -Q update -dP -r MOODLE_18_STABLE

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

====For Windows servers====

You can use Tortoise CVS to do the initial checkout and the updates.

If you have been editing Moodle files, watch the messages very closely for possible conflicts. All your customised themes and non-standard plugins will be untouched.

Do not forget to trigger the install process in the site administration block (see below).

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

In general, it is recommended to upgrade via each version of Moodle, for example 1.7 -> 1.9. An exception to this is when upgrading from 1.5 or 1.6, when it is recommended that 1.7 and 1.8 are skipped, in other words upgrade 1.5 -> 1.6 -> 1.9. (The main reason for this recommendation is that the default roles settings obtained when upgrading to 1.7 are not ideal for 1.8 onwards, 1.8 has problems with groups, etc.)

==See also==

*[[Installing Moodle]]
*[[Installation FAQ]]
*[[Upgrading to Moodle 1.6]]
*[[Upgrading to Moodle 1.8]]
*[[Upgrading to Moodle 1.9]]
*[[Upgrading to Moodle 2.0]]
*[[Environment]]
*[[Git]] Version control and 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).

Using Moodle.org forum discussions:
*[http://moodle.org/mod/forum/discuss.php?d=26731&parent=125858 Using cvs]
*[http://moodle.org/mod/forum/discuss.php?d=56915 Upgrading from 1.5.2 to 1.7]
*[http://moodle.org/mod/forum/discuss.php?d=56991 Upgrade nightmares.... any help appreciated]
*[http://moodle.org/mod/forum/discuss.php?d=62463 After upgrading i get "Your site may not be secure." msg]
*[http://moodle.org/mod/forum/discuss.php?d=104887 Best practices for QA]

[[Category:Installation]]

[[es:Actualización de moodle]]
[[fr:Mise à jour]]
[[ja:アップグレード]]
[[nl:Upgraden]]
[[zh:升级]]
[[pl:Aktualizacja]]
[[de:Aktualisierung von Moodle]]
[[ru:Обновление]]