MoodleDocs - Användarbidrag [sv]

Nginx

2022-10-02T12:34:33Z

Mina: /* PHP-FPM */ Update path

{{Installing Moodle}}{{Update}}[[Nginx]] [engine x] is an HTTP and reverse proxy server, as well as a mail proxy server, written by Igor Sysoev. The nginx project started with a strong focus on high concurrency, high performance and low memory usage. It is licensed under the 2-clause BSD-like license and it runs on Linux, BSD variants, Mac OS X, Solaris, AIX, HP-UX, as well as on other *nix flavours. It also has a proof of concept port for Microsoft Windows.

''The following is community-contributed documentation on Nginx configuration. Amendments and additions are welcome.''

== Nginx configuration ==

=== PHP-FPM ===

Nginx is usually configured to interface with PHP via [http://php.net/manual/en/install.fpm.php php-fpm]. This is both fast and robust.

PHP-FPM's default behaviour for pools is usually to restrict the execution of scripts to a specific extension, i.e. .php. You should ensure that this behaviour is configured within your particular package/distribution, e.g. for debian,

'''/etc/php/7.4/fpm/pool.d/www.conf'''
security.limit_extensions = .php

=== Nginx ===

Add the following 'slash arguments' compatible 'location' block to your vhosts 'server' in your nginx configuration (further explanation at '[[Using slash arguments]]').

'''nginx.conf location:'''
<pre>
location ~ [^/]\.php(/|$) {
fastcgi_split_path_info ^(.+\.php)(/.+)$;
fastcgi_index index.php;
fastcgi_pass 127.0.0.1:9000 (or your php-fpm socket);
include fastcgi_params;
fastcgi_param PATH_INFO $fastcgi_path_info;
fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
}
</pre>

If the above does not work try the following:
Note: This was for CentOS 7.6 (1804), MariaDB 10.3, Nginx 1.15 and PHP 7.3.5
<pre>
location ~ ^(.+\.php)(.*)$ {
root /usr/share/nginx/html/moodle/;
fastcgi_split_path_info ^(.+\.php)(.*)$;
fastcgi_index index.php;
fastcgi_pass 127.0.0.1:9000;
include /etc/nginx/mime.types;
include fastcgi_params;
fastcgi_param PATH_INFO $fastcgi_path_info;
fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
}
</pre>

If you find that this does not work (scripts, styles, and images not loading) '''and''' that there are <code>open() "..." failed (20: Not a directory)</code> lines appearing in your logs: Check whether there are any directives related to static content '''before''' this block and try moving them '''after''' this block.

Another potential pitfall is the use of '''try_files'''. Many guides recommend configurations like <pre>try_files $fastcgi_script_name =404;</pre>. But if try_files is used, nginx deletes the content of the '''$fastcgi_path_info''' variable (this is [https://trac.nginx.org/nginx/ticket/321 intended behavior]). This causes '''PATH_INFO''' to also be empty, so slash arguments don't work.
An alternative is the use of <pre>if(!-f $document_root$fastcgi_script_name) {return 404;}</pre> [https://www.nginx.com/resources/wiki/start/topics/examples/phpfcgi/#connecting-nginx-to-php-fpm as recommended] by the nginx documentation, although the nginx documentation also recommends [https://www.nginx.com/resources/wiki/start/topics/depth/ifisevil/ not using if].

==== Error pages ====

<pre>
# This passes 404 pages to Moodle so they can be themed
error_page 404 /error/index.php; error_page 403 =404 /error/index.php;
</pre>

==== Hiding internal files ====

<pre>
# Hide all dot files but allow "Well-Known URIs" as per RFC 5785
location ~ /\.(?!well-known).* {
return 404;
}

# This should be after the php fpm rule and very close to the last nginx ruleset.
# Don't allow direct access to various internal files. See MDL-69333
location ~ (/vendor/|/node_modules/|composer\.json|/readme|/README|readme\.txt|/upgrade\.txt|db/install\.xml|/fixtures/|/behat/|phpunit\.xml|\.lock|environment\.xml) {
deny all;
return 404;
}
</pre>

==== XSendfile aka X-Accel-Redirect ====

Setting Moodle and Nginx to use XSendfile functionality is a big win as it frees PHP from delivering files allowing Nginx to do what it does best, i.e. deliver files.

Enable xsendfile for Nginx in Moodles config.php, this is documented in the config-dist.php, a minimal configuration look like this,
<pre>
$CFG->xsendfile = 'X-Accel-Redirect';
$CFG->xsendfilealiases = array(
'/dataroot/' => $CFG->dataroot
);
</pre>
Accompany this with a matching 'location' block in your nginx server configuration.
<pre>
location /dataroot/ {
internal;
alias <full_moodledata_path>; # ensure the path ends with /
}
</pre>
The definition of 'internal' here is '''critical''' as it prevents client access to your dataroot.

==== Load Balancer Hints (AWS) ====

If you're using an AWS load balancer in front your infrastructure, you can set up some of the configuration above, preventing traffic to go forward. Here is the configuration applied to hide files, with a few considerations due to known limitations:
* 100 total rules per application load balancer
* 5 condition values per rule
* 5 wildcards per rule
* 5 weighted target groups per rule:
<small>
<pre>
[
{
"Conditions": [
{
"Field": "path-pattern",
"Values": [
"*/.*",
"*/upgrade.txt",
"*/db/install.xml",
"*/README.md"
],
"PathPatternConfig": {
"Values": [
"*/.*",
"*/upgrade.txt",
"*/db/install.xml",
"*/README.md"
]
}
}
],
"Actions": [
{
"Type": "fixed-response",
"Order": 1,
"FixedResponseConfig": {
"ContentType": "text/html",
"MessageBody": "<html>\n<head><title>404 Not Found</title></head>\n<body>\n<center><h1>404 Not Found</h1></center>\n<hr>\n</body>\n</html>",
"StatusCode": "404"
}
}
]
},
{
"Conditions": [
{
"Field": "path-pattern",
"Values": [
"*/composer.json",
"*/Gruntfile.js",
"*.lock",
"*/environtment.xml",
"*/readme.txt"
],
"PathPatternConfig": {
"Values": [
"*/composer.json",
"*/Gruntfile.js",
"*.lock",
"*/environtment.xml",
"*/readme.txt"
]
}
}
],
"Actions": [ #### Same as above
...
]
},
{
"Conditions": [
{
"Field": "path-pattern",
"Values": [
"*/fixtures/*",
"*/behat/*",
"*/phpunit.xml"
],
"PathPatternConfig": {
"Values": [
"*/fixtures/*",
"*/behat/*",
"*/phpunit.xml"
]
}
}
],
"Actions": [ #### Same as above
...
]
}
]
</pre></small>

== See also ==

* Real <tt>PATH_INFO</tt> support:
** https://moodle.org/mod/forum/discuss.php?d=278916
** https://moodle.org/mod/forum/discuss.php?d=307388
* '''[Deprecated]''' Internal rewriting to the HTTP GET <tt>file</tt> parameter:
** https://moodle.org/mod/forum/discuss.php?d=83445

[[Category:Installation]]

[[es:Nginx]]
[[pt-br:Nginx]]

AMOS manual

2022-08-18T17:45:56Z

Mina: /* Using the stage */ Fix link

{{Translation}}

'''AMOS stands for Automated Manipulation Of Strings. AMOS is a central repository of Moodle strings and their history. It tracks the addition of English strings into Moodle code, gathers translations, handles common translation tasks and generates language packages to be deployed on Moodle servers.'''

The name was chosen in honour of [https://en.wikipedia.org/wiki/John_Amos_Comenius John Amos Comenius], the author of ''Janua linguarum reserata'' (Gate to Languages Unlocked). Sorry Tori ;-)

AMOS is hosted on our '''[https://lang.moodle.org Moodle translation site]'''.

== Basic concepts ==

AMOS consists of several tools available via the main navigation block - Translator, Stage, Stashes, Contributions and Log.

* Translator - is a tool that allows you to filter strings you want to work on and translate them.
* Stage - is a temporary working area that holds the strings you have translated during the current session. Maintainers can permanently commit the stage into the strings repository. Contributors can submit the stage for maintainers.
* Stashes - are snapshots of the stage. Imagine them as ordinary files at your computer where you can save your work. You can submit your stash to the language pack maintainers.
* Contributions - is a database tracking all submitted contributions and their current status. Records in this database are like issues in the Moodle tracker with the translated strings attached.
* Repository - a database of all Moodle strings and their history running at lang.moodle.org server.
* Log - displays the log of all modifications of Moodle strings.

== Translation workflow ==

The following data flow diagram illustrates how AMOS tools are used during the translation process.

[[image:amos-workflow4.png]]

The key AMOS component is the staging area or shortly the stage. It holds translated strings temporarily during your current login session. If you log out, the stage is cleared (though there is a backup - see below). There are several ways how translations can be staged, that is how translated strings can be put into the stage:

* by using the AMOS translator
* by importing strings from an uploaded file
* by applying a previously created stash
* by applying a submitted contribution

Language pack maintainers have write access to the AMOS strings repository. Therefore they can commit their stage permanently. Once the stage is committed, staged strings are stored in the AMOS repository. Every hour, AMOS generates ZIP packages from the most recent snapshot of the repository. These ZIP packages are published on the language pack download pages https://download.moodle.org/langpack/. In addition, Moodle sites can install and update language packages automatically via ''Site administration > Language > Language packs''.

Community members do not have write access to the repository so they can't commit their stage. Instead, they can submit it to the maintainers. By submitting a stage, a new contribution record is created and language pack maintainers are notified by automatic email message. Maintainers can review the submitted contribution and, if they accept it, commit it on behalf of the contributor.

The stage can be also saved so you can interrupt your work and continue next time you come back to the site. The stage is saved into the so called 'stashing area'. The stashing area consists of stashes. A new stash is simply a snapshot copy of your current stage. AMOS automatically keeps one stash for you as a backup copy of your most recent stage. A stash can be submitted to the maintainers too.

== AMOS tools ==

=== Using the translator tool ===

[[image:amos-screenshot-translator.png|300px|thumb|right|AMOS Translator tool]]
The translator tool page has two main parts. At the top, there is a filter form (1). You use that filter to get the strings you want to translate. When the filter settings are saved (2), a table with the filtered strings is displayed below.

Every row in the table represents a single string. The table has four columns. The first column (3) describes the version (or branch) where the string is used, its identifier and its component. You can see a text like

4.0 [completiondate,coursereport_completion]

That reads: this string is used in Moodle 4.0, its identifier is 'completiondate' and it belongs to 'courserepor_completion' component.

The second column (4) contains the English original of the string. Below the text, you can see Google icon. Click that icon to get automatic translation of the string into the language being translated. The next column contains a code of the language that this string is being translated to (for example "cs" for Czech).

Finally the last column contains the translation itself. If it is empty, the string is not translated yet, otherwise it displays the current translation. '''Click in the cell to turn it into the input editor.''' Insert the translation and click outside the cell to stage the translation. Note there is no submit button, the text is sent to the stage automatically in the background. You can see that the colour of the cell turned blue. Blue colour signalizes that the translation is currently staged.

You have many options of how to use the strings filter. You can work on a single component or all missing strings at once. You can search for strings containing a given text (either in English or the translated string) etc. You can check for strings in older versions, too but those strings are read-only. They get automatically pulled into AMOS from the CVS repository of 1.x translations.

The 'permalink' below the filter's submit button can be used to keep the current filter settings. For example, you can bookmark a setting use regularly or you can copy the link URL and send it to somebody so they can set their filter just by visiting that URL.

When you finish translating, do not forget to visit the stage page. You probably want either commit it (if you are a lang pack maintainer) or submit it to maintainers so they can review your work and include it into the language pack.

Sadly, sometimes, AMOS may consider that your request-URI is too large to handle :(

[[File:amos_permalink_request -uri too large4.png|600px]]

=== Using the stage ===

[[File:amos-screenshot-stage-contrib.png|300px|thumb|right|Strings staged by a contributor]]
The translated strings are put into a temporary area called ''stage'' immediately after the cursor leaves the editor field. The stage holds your work before it is either committed into the repository (if you are language pack maintainer) or submitted to the maintainers for inclusion or stashed.

The stage is cleared when you logout. You have to explicitly commit or stash the stage so it is saved permanently. If you forget to do it, or there is a problem with the connectivity, your browser crashes or whatever, you can find your most recent snapshot of the stage in autosave stash.

If you are language pack maintainer, you can commit the stage into the repository so your work is registered and the translated strings become part of the official language package. You can also propagate the strings to other branches by selecting the branches you want the string to go to and hit the propagate button. It is a wise thing to do that, to save work and to keep consistency in the wording over the versions.

Updated language packages in ZIP format are published hourly at https://download.moodle.org/langpack/4.0/ - look at the bottom of the page to see the last update. At the same time, they become available for Moodle sites for automatic update.

The stage can also be used to import strings from files and to merge or compare versions of language packs.

=== Importing a file ===

[[File:amos-screenshot-stage-empty.png|300px|thumb|right|Empty stage allows you to import strings from a file]]
Strings can be translated offline and uploaded back to AMOS using the stage page. The only supported format at the moment is common PHP format used by Moodle where strings are defined in associative array called $string. For obvious security reasons, AMOS can not actually execute PHP files uploaded by users. Instead, it parses the uploaded file in a similar way as PHP parser, looking for patterns that are considered as valid string definition. That means that not every valid PHP code is valid string definition. AMOS parser requires following conditions are met:

* the filename is valid component name used by Moodle, for example moodle.php, enrol_manual.php or workshop.php
* the file is valid PHP code without syntax errors - that means is passes the PHP lint check
* strings are defined as elements of global array $string
* strings are single quoted constants

Example of a valid file to import into AMOS (filename countries.php, Czech translation)

<?php

$string['AE'] = 'Spojené Arabské emiráty';
$string['AF'] = 'Afghánistán';
$string['CH'] = 'Švýcarsko';
$string['HU'] = 'Maďarsko';

?>

During the import, strings found in the file are added into your stage as if they were translated via web. You can commit them into repository if you have such privilege.

You can import several .php files at once if you put them into a ZIP file (Maximum size: 2MB) and import this ZIP file.

=== Using stashes ===

At any moment, you can save a snapshot of the current stage. We call such snapshot a ''stash''. Stashed strings are kept forever until you drop them manually (please do not abuse this and keep your stashes reasonable big). To manage your stash, click on Stashes in the right menu of AMOS. You just see a list of the stashes. There are "peekaboo" buttons that appear when you mouse hoover over the stashes. The stash can be ''applied'' so that the stashed strings are copied back to the stage. What the ''pop'' does is apply and drop (delete) the stash. ''drop'' is like delete. ''submit to maintainer'' opens a form for doing just that.

There is one special stash record for every user called autosave stash. This stash keeps the most recent state of the stage. You may find it useful if you loose the current stage for any reason - your browser crashes, your internet connectivity dies or you accidentally unstage all strings. If that happens, just apply the autosave stash to get your work back. The autosave stash is updated every time you stage a string. So if your stage is empty and your autosave stash is full of strings and you go into the translator first without applying the stash, the autosave will be replaced with the new translated string. We recommend to experiment a bit with this feature first.

=== Using the log tool ===

The Log page allows even anonymous users to search in the history of commits tracked by AMOS. At the top of the page there is a filter that allows you to look for a particular information or report. It is important to realize how the filter actually works. Searching and filtering happens in two steps (this was necessary for performance reasons):

* Firstly, commit records are searched based on the criteria specified in the Commit filter form. If there are more commits found matching the filter settings, only 100 most recent commits are processed.
* Then, within the commits found, either all string modification records are returned, or you can filter these records, too. Settings in String filter form section are used in that case.

By default, the filter looks for all commits since the last time you logged in and than displays only strings at the currently translated branch modified by those commits.

===Language packs and Moodle versions===

When a new Moodle version is released, it will become the default version on your Amos - Translator page (see tick boxes at the top).

The suggested work flow is to continue your translation work for the new Moodle version and merge your work in the older versions.
Some time ago, people used to do that using the Amos - Stage page: Set the source version to the version you were working in and set the target version to the version you want the strings to be copied to. Nowadays AMOS automatically propagates (most of) the strings to all suitable branches.

==Keeping track of your 'favorite' plugins strings to translate==
You can use the ''permalink'' feature for frequently checking a finite set of additional plugins for missing or outdated string.

The permalink feature is supposed to work like this:
* You use the AMOS filter settings (that is, you define which versions, components, etc, you want to see). For example, you can select version 4.0, then all core components and some additional components.
* You press "Save filter settings" and let AMOS show you the strings.
* Then you can copy or bookmark the URL that is available via the "Permalink" link.
* Following that URL should set the filter back to the current settings.

* The problem is that AMOS does not allow you to mix strings from one component version with strings from another component version at the moment. So you can't see things like "Workshop 3.11 strings together with Essential 3.9 strings". You would have to select both 3.11 and 3.9 version fields, and both Workshop and Essential components. But that would lead to Workshop strings being displayed twice.

{{Note|It would be useful for you to have a couple of bookmarked / saved permalinks per version. So you would have one for "4.0 core and interesting additional plugins", another one for "3.11 interesting plugins", another one for "3.10 interesting plugins" etc. That way, you can regularly check these three or four links and have your areas of interested monitored well.}}

== See also ==
* [https://www.youtube.com/watch?v=JtY5zvEHnQ8 Accepting submissions] Instruction video for language pack maintainers
* [https://www.youtube.com/watch?v=XClUZOuFfWo Contributing to a language pack] Instruction video for language pack contributors
* [https://www.youtube.com/watch?v=xT2-ElTaH6M Changing the default language] Instruction video on how to change your default language

[[fr:AMOS]]
[[es:AMOS]]

MoodleBox

2022-04-23T16:30:41Z

Mina: /* Features */

{{Infobox plugin
|type = Admin Tool
|entry = https://moodle.org/plugins/view.php?plugin=tool_moodlebox
|tracker = https://github.com/moodlebox/moodle-tool_moodlebox/issues
|discussion = https://discuss.moodlebox.net
|maintainer = [[User:Nicolas Martignoni|Nicolas Martignoni]]
|float = right
}}
{{Note|You can find the most up-to-date documentation for this plugin in the MoodleBox webpage at https://moodlebox.net. This page is intended for users that click on the 'Moodle Docs for this page' link.}}
The [https://moodle.org/plugins/view.php?plugin=tool_moodlebox MoodleBox plugin for Moodle] is an administration tool providing a GUI to some settings and management of a [https://moodlebox.net MoodleBox], a Moodle server installed on a [https://en.wikipedia.org/wiki/Raspberry_Pi Raspberry Pi].

It enables a Moodle administrator to monitor some hardware settings, to set the date of the [https://moodlebox.net MoodleBox], to allow restart and shutdown of the [https://moodlebox.net MoodleBox] and changing Raspberry Pi passwords using a GUI. After the installation in Moodle, some steps are required to complete on the Raspberry Pi (see below).

The plugin is compatible with Moodle 3.6 or later. A Raspberry Pi model 3A+, 3B, 3B+ or 4B is recommended.

== Requirements ==

* A [https://en.wikipedia.org/wiki/Raspberry_Pi Raspberry Pi] (Model 3A+, 3B, 3B+ or 4B recommended)
* [https://en.wikipedia.org/wiki/Raspbian Raspbian] installed (or another Linux based distribution)
* Package Incron installed
* Moodle installed (obviously)

== Installation==

The MoodleBox plugin must be installed in the Moodle tree of the [https://moodlebox.net MoodleBox], in the tool folder. Once installed, an new option MoodleBox will be available in Moodle, under ''Site administration > Server'' in the Administration block.

To complete the installation, you have to configure some `direvent` jobs on the MoodleBox.

1. Install `direvent` package:
```bash
sudo apt-get install direvent
```

1. Add following lines to file `/etc/direvent.conf`:
```bash
# This is the configuration file for direvent. Read
# direvent.conf(5) for more information about how to
# fill this file.

debug 0;

watcher {
path /var/www/moodle/admin/tool/moodlebox/;
file .reboot-server;
event CLOSE_WRITE;
command "/sbin/shutdown -r now";
}

watcher {
path /var/www/moodle/admin/tool/moodlebox/;
file .shutdown-server;
event CLOSE_WRITE;
command "/sbin/shutdown -h now";
}

watcher {
path /var/www/moodle/admin/tool/moodlebox/;
file .set-server-datetime;
event CLOSE_WRITE;
command "/bin/bash /var/www/moodle/admin/tool/moodlebox/.set-server-datetime";
}

watcher {
path /var/www/moodle/admin/tool/moodlebox/;
file .newpassword;
event CLOSE_WRITE;
command "/bin/bash /var/www/moodle/admin/tool/moodlebox/bin/changepassword.sh";
}

watcher {
path /var/www/moodle/admin/tool/moodlebox/;
file .wifisettings;
event CLOSE_WRITE;
command "/usr/bin/python3 /var/www/moodle/admin/tool/moodlebox/bin/changewifisettings.py";
}

watcher {
path /var/www/moodle/admin/tool/moodlebox/;
file .resize-partition;
event CLOSE_WRITE;
command "/bin/bash /var/www/moodle/admin/tool/moodlebox/bin/resizepartition.sh";
}
```

=== Copy the following line at the end of file /etc/sudoers ===
www-data ALL=(ALL) NOPASSWD:/sbin/parted /dev/mmcblk0 unit MB print free
www-data ALL=(ALL) NOPASSWD:/usr/bin/vcgencmd

=== If you use PiJuice, install the related packages ===
sudo apt-get install pijuice-base
sudo adduser www-data i2c

and reboot

=== [[Secure Moodle on Raspberry Pi Model 2, Gentoo Linux and Nginx server|Secure your Moodlebox]] ===

This is not needed in normal MoodleBox use, i.e. if you don't expose your MoodleBox on the Internet.

== Features ==

* Info about the MoodleBox (kernel version, Raspberry Pi OS version, free space on SD card, CPU load, CPU temperature, CPU frequency, uptime, DHCP clients and more).
* Warning when under voltage detected.
* GUI to set the MoodleBox date and time.
* GUI to set the MoodleBox password.
* GUI to set the MoodleBox Wi-Fi settings: SSID and its visibility, regulatory country, channel, password (or remove password) and fixed IP address.
* GUI to resize the partition of the SD card of the MoodleBox, when needed.
* GUI to restart and shutdown the MoodleBox.

== Availability ==

The code is available at [https://github.com/moodlebox/moodle-tool_moodlebox https://github.com/moodlebox/moodle-tool_moodlebox].

== See also ==

* [https://moodlebox.net MoodleBox documentation]

[[Category:Contributed code]]

[[es:MoodleBox]]

MoodleBox

2022-04-23T16:30:18Z

Mina: /* Features */

{{Infobox plugin
|type = Admin Tool
|entry = https://moodle.org/plugins/view.php?plugin=tool_moodlebox
|tracker = https://github.com/moodlebox/moodle-tool_moodlebox/issues
|discussion = https://discuss.moodlebox.net
|maintainer = [[User:Nicolas Martignoni|Nicolas Martignoni]]
|float = right
}}
{{Note|You can find the most up-to-date documentation for this plugin in the MoodleBox webpage at https://moodlebox.net. This page is intended for users that click on the 'Moodle Docs for this page' link.}}
The [https://moodle.org/plugins/view.php?plugin=tool_moodlebox MoodleBox plugin for Moodle] is an administration tool providing a GUI to some settings and management of a [https://moodlebox.net MoodleBox], a Moodle server installed on a [https://en.wikipedia.org/wiki/Raspberry_Pi Raspberry Pi].

It enables a Moodle administrator to monitor some hardware settings, to set the date of the [https://moodlebox.net MoodleBox], to allow restart and shutdown of the [https://moodlebox.net MoodleBox] and changing Raspberry Pi passwords using a GUI. After the installation in Moodle, some steps are required to complete on the Raspberry Pi (see below).

The plugin is compatible with Moodle 3.6 or later. A Raspberry Pi model 3A+, 3B, 3B+ or 4B is recommended.

== Requirements ==

* A [https://en.wikipedia.org/wiki/Raspberry_Pi Raspberry Pi] (Model 3A+, 3B, 3B+ or 4B recommended)
* [https://en.wikipedia.org/wiki/Raspbian Raspbian] installed (or another Linux based distribution)
* Package Incron installed
* Moodle installed (obviously)

== Installation==

The MoodleBox plugin must be installed in the Moodle tree of the [https://moodlebox.net MoodleBox], in the tool folder. Once installed, an new option MoodleBox will be available in Moodle, under ''Site administration > Server'' in the Administration block.

To complete the installation, you have to configure some `direvent` jobs on the MoodleBox.

1. Install `direvent` package:
```bash
sudo apt-get install direvent
```

1. Add following lines to file `/etc/direvent.conf`:
```bash
# This is the configuration file for direvent. Read
# direvent.conf(5) for more information about how to
# fill this file.

debug 0;

watcher {
path /var/www/moodle/admin/tool/moodlebox/;
file .reboot-server;
event CLOSE_WRITE;
command "/sbin/shutdown -r now";
}

watcher {
path /var/www/moodle/admin/tool/moodlebox/;
file .shutdown-server;
event CLOSE_WRITE;
command "/sbin/shutdown -h now";
}

watcher {
path /var/www/moodle/admin/tool/moodlebox/;
file .set-server-datetime;
event CLOSE_WRITE;
command "/bin/bash /var/www/moodle/admin/tool/moodlebox/.set-server-datetime";
}

watcher {
path /var/www/moodle/admin/tool/moodlebox/;
file .newpassword;
event CLOSE_WRITE;
command "/bin/bash /var/www/moodle/admin/tool/moodlebox/bin/changepassword.sh";
}

watcher {
path /var/www/moodle/admin/tool/moodlebox/;
file .wifisettings;
event CLOSE_WRITE;
command "/usr/bin/python3 /var/www/moodle/admin/tool/moodlebox/bin/changewifisettings.py";
}

watcher {
path /var/www/moodle/admin/tool/moodlebox/;
file .resize-partition;
event CLOSE_WRITE;
command "/bin/bash /var/www/moodle/admin/tool/moodlebox/bin/resizepartition.sh";
}
```

=== Copy the following line at the end of file /etc/sudoers ===
www-data ALL=(ALL) NOPASSWD:/sbin/parted /dev/mmcblk0 unit MB print free
www-data ALL=(ALL) NOPASSWD:/usr/bin/vcgencmd

=== If you use PiJuice, install the related packages ===
sudo apt-get install pijuice-base
sudo adduser www-data i2c

and reboot

=== [[Secure Moodle on Raspberry Pi Model 2, Gentoo Linux and Nginx server|Secure your Moodlebox]] ===

This is not needed in normal MoodleBox use, i.e. if you don't expose your MoodleBox on the Internet.

== Features ==

- Info about the MoodleBox (kernel version, Raspberry Pi OS version, free space on SD card, CPU load, CPU temperature, CPU frequency, uptime, DHCP clients and more).
- Warning when under voltage detected.
- GUI to set the MoodleBox date and time.
- GUI to set the MoodleBox password.
- GUI to set the MoodleBox Wi-Fi settings: SSID and its visibility, regulatory country, channel, password (or remove password) and fixed IP address.
- GUI to resize the partition of the SD card of the MoodleBox, when needed.
- GUI to restart and shutdown the MoodleBox.

== Availability ==

The code is available at [https://github.com/moodlebox/moodle-tool_moodlebox https://github.com/moodlebox/moodle-tool_moodlebox].

== See also ==

* [https://moodlebox.net MoodleBox documentation]

[[Category:Contributed code]]

[[es:MoodleBox]]

MoodleBox

2022-04-23T16:30:02Z

Mina: PiJuice instructions

{{Infobox plugin
|type = Admin Tool
|entry = https://moodle.org/plugins/view.php?plugin=tool_moodlebox
|tracker = https://github.com/moodlebox/moodle-tool_moodlebox/issues
|discussion = https://discuss.moodlebox.net
|maintainer = [[User:Nicolas Martignoni|Nicolas Martignoni]]
|float = right
}}
{{Note|You can find the most up-to-date documentation for this plugin in the MoodleBox webpage at https://moodlebox.net. This page is intended for users that click on the 'Moodle Docs for this page' link.}}
The [https://moodle.org/plugins/view.php?plugin=tool_moodlebox MoodleBox plugin for Moodle] is an administration tool providing a GUI to some settings and management of a [https://moodlebox.net MoodleBox], a Moodle server installed on a [https://en.wikipedia.org/wiki/Raspberry_Pi Raspberry Pi].

It enables a Moodle administrator to monitor some hardware settings, to set the date of the [https://moodlebox.net MoodleBox], to allow restart and shutdown of the [https://moodlebox.net MoodleBox] and changing Raspberry Pi passwords using a GUI. After the installation in Moodle, some steps are required to complete on the Raspberry Pi (see below).

The plugin is compatible with Moodle 3.6 or later. A Raspberry Pi model 3A+, 3B, 3B+ or 4B is recommended.

== Requirements ==

* A [https://en.wikipedia.org/wiki/Raspberry_Pi Raspberry Pi] (Model 3A+, 3B, 3B+ or 4B recommended)
* [https://en.wikipedia.org/wiki/Raspbian Raspbian] installed (or another Linux based distribution)
* Package Incron installed
* Moodle installed (obviously)

== Installation==

The MoodleBox plugin must be installed in the Moodle tree of the [https://moodlebox.net MoodleBox], in the tool folder. Once installed, an new option MoodleBox will be available in Moodle, under ''Site administration > Server'' in the Administration block.

To complete the installation, you have to configure some `direvent` jobs on the MoodleBox.

1. Install `direvent` package:
```bash
sudo apt-get install direvent
```

1. Add following lines to file `/etc/direvent.conf`:
```bash
# This is the configuration file for direvent. Read
# direvent.conf(5) for more information about how to
# fill this file.

debug 0;

watcher {
path /var/www/moodle/admin/tool/moodlebox/;
file .reboot-server;
event CLOSE_WRITE;
command "/sbin/shutdown -r now";
}

watcher {
path /var/www/moodle/admin/tool/moodlebox/;
file .shutdown-server;
event CLOSE_WRITE;
command "/sbin/shutdown -h now";
}

watcher {
path /var/www/moodle/admin/tool/moodlebox/;
file .set-server-datetime;
event CLOSE_WRITE;
command "/bin/bash /var/www/moodle/admin/tool/moodlebox/.set-server-datetime";
}

watcher {
path /var/www/moodle/admin/tool/moodlebox/;
file .newpassword;
event CLOSE_WRITE;
command "/bin/bash /var/www/moodle/admin/tool/moodlebox/bin/changepassword.sh";
}

watcher {
path /var/www/moodle/admin/tool/moodlebox/;
file .wifisettings;
event CLOSE_WRITE;
command "/usr/bin/python3 /var/www/moodle/admin/tool/moodlebox/bin/changewifisettings.py";
}

watcher {
path /var/www/moodle/admin/tool/moodlebox/;
file .resize-partition;
event CLOSE_WRITE;
command "/bin/bash /var/www/moodle/admin/tool/moodlebox/bin/resizepartition.sh";
}
```

=== Copy the following line at the end of file /etc/sudoers ===
www-data ALL=(ALL) NOPASSWD:/sbin/parted /dev/mmcblk0 unit MB print free
www-data ALL=(ALL) NOPASSWD:/usr/bin/vcgencmd

=== If you use PiJuice, install the related packages ===
sudo apt-get install pijuice-base
sudo adduser www-data i2c

and reboot

=== [[Secure Moodle on Raspberry Pi Model 2, Gentoo Linux and Nginx server|Secure your Moodlebox]] ===

This is not needed in normal MoodleBox use, i.e. if you don't expose your MoodleBox on the Internet.

== Features ==

* Info about the MoodleBox (kernel version, Raspbian version, free space on SD card, CPU load, CPU temperature, CPU frequency, uptime, DHCP clients).
* GUI to set the MoodleBox date and time.
* GUI to set the MoodleBox password.
* GUI to set the MoodleBox Wi-Fi network password, SSID and channel.
* GUI to restart and shutdown the MoodleBox.

== Availability ==

The code is available at [https://github.com/moodlebox/moodle-tool_moodlebox https://github.com/moodlebox/moodle-tool_moodlebox].

== See also ==

* [https://moodlebox.net MoodleBox documentation]

[[Category:Contributed code]]

[[es:MoodleBox]]

MoodleBox

2022-04-23T16:28:41Z

Mina: /* Copy the following line at the end of file /etc/sudoers */ update instructions

{{Infobox plugin
|type = Admin Tool
|entry = https://moodle.org/plugins/view.php?plugin=tool_moodlebox
|tracker = https://github.com/moodlebox/moodle-tool_moodlebox/issues
|discussion = https://discuss.moodlebox.net
|maintainer = [[User:Nicolas Martignoni|Nicolas Martignoni]]
|float = right
}}
{{Note|You can find the most up-to-date documentation for this plugin in the MoodleBox webpage at https://moodlebox.net. This page is intended for users that click on the 'Moodle Docs for this page' link.}}
The [https://moodle.org/plugins/view.php?plugin=tool_moodlebox MoodleBox plugin for Moodle] is an administration tool providing a GUI to some settings and management of a [https://moodlebox.net MoodleBox], a Moodle server installed on a [https://en.wikipedia.org/wiki/Raspberry_Pi Raspberry Pi].

It enables a Moodle administrator to monitor some hardware settings, to set the date of the [https://moodlebox.net MoodleBox], to allow restart and shutdown of the [https://moodlebox.net MoodleBox] and changing Raspberry Pi passwords using a GUI. After the installation in Moodle, some steps are required to complete on the Raspberry Pi (see below).

The plugin is compatible with Moodle 3.6 or later. A Raspberry Pi model 3A+, 3B, 3B+ or 4B is recommended.

== Requirements ==

* A [https://en.wikipedia.org/wiki/Raspberry_Pi Raspberry Pi] (Model 3A+, 3B, 3B+ or 4B recommended)
* [https://en.wikipedia.org/wiki/Raspbian Raspbian] installed (or another Linux based distribution)
* Package Incron installed
* Moodle installed (obviously)

== Installation==

The MoodleBox plugin must be installed in the Moodle tree of the [https://moodlebox.net MoodleBox], in the tool folder. Once installed, an new option MoodleBox will be available in Moodle, under ''Site administration > Server'' in the Administration block.

To complete the installation, you have to configure some `direvent` jobs on the MoodleBox.

1. Install `direvent` package:
```bash
sudo apt-get install direvent
```

1. Add following lines to file `/etc/direvent.conf`:
```bash
# This is the configuration file for direvent. Read
# direvent.conf(5) for more information about how to
# fill this file.

debug 0;

watcher {
path /var/www/moodle/admin/tool/moodlebox/;
file .reboot-server;
event CLOSE_WRITE;
command "/sbin/shutdown -r now";
}

watcher {
path /var/www/moodle/admin/tool/moodlebox/;
file .shutdown-server;
event CLOSE_WRITE;
command "/sbin/shutdown -h now";
}

watcher {
path /var/www/moodle/admin/tool/moodlebox/;
file .set-server-datetime;
event CLOSE_WRITE;
command "/bin/bash /var/www/moodle/admin/tool/moodlebox/.set-server-datetime";
}

watcher {
path /var/www/moodle/admin/tool/moodlebox/;
file .newpassword;
event CLOSE_WRITE;
command "/bin/bash /var/www/moodle/admin/tool/moodlebox/bin/changepassword.sh";
}

watcher {
path /var/www/moodle/admin/tool/moodlebox/;
file .wifisettings;
event CLOSE_WRITE;
command "/usr/bin/python3 /var/www/moodle/admin/tool/moodlebox/bin/changewifisettings.py";
}

watcher {
path /var/www/moodle/admin/tool/moodlebox/;
file .resize-partition;
event CLOSE_WRITE;
command "/bin/bash /var/www/moodle/admin/tool/moodlebox/bin/resizepartition.sh";
}
```

=== Copy the following line at the end of file /etc/sudoers ===
www-data ALL=(ALL) NOPASSWD:/sbin/parted /dev/mmcblk0 unit MB print free
www-data ALL=(ALL) NOPASSWD:/usr/bin/vcgencmd

=== [[Secure Moodle on Raspberry Pi Model 2, Gentoo Linux and Nginx server|Secure your Moodlebox]] ===

This is not needed in normal MoodleBox use, i.e. if you don't expose your MoodleBox on the Internet.

== Features ==

* Info about the MoodleBox (kernel version, Raspbian version, free space on SD card, CPU load, CPU temperature, CPU frequency, uptime, DHCP clients).
* GUI to set the MoodleBox date and time.
* GUI to set the MoodleBox password.
* GUI to set the MoodleBox Wi-Fi network password, SSID and channel.
* GUI to restart and shutdown the MoodleBox.

== Availability ==

The code is available at [https://github.com/moodlebox/moodle-tool_moodlebox https://github.com/moodlebox/moodle-tool_moodlebox].

== See also ==

* [https://moodlebox.net MoodleBox documentation]

[[Category:Contributed code]]

[[es:MoodleBox]]

MoodleBox

2022-04-23T16:28:19Z

Mina: Update postinstall instructions

{{Infobox plugin
|type = Admin Tool
|entry = https://moodle.org/plugins/view.php?plugin=tool_moodlebox
|tracker = https://github.com/moodlebox/moodle-tool_moodlebox/issues
|discussion = https://discuss.moodlebox.net
|maintainer = [[User:Nicolas Martignoni|Nicolas Martignoni]]
|float = right
}}
{{Note|You can find the most up-to-date documentation for this plugin in the MoodleBox webpage at https://moodlebox.net. This page is intended for users that click on the 'Moodle Docs for this page' link.}}
The [https://moodle.org/plugins/view.php?plugin=tool_moodlebox MoodleBox plugin for Moodle] is an administration tool providing a GUI to some settings and management of a [https://moodlebox.net MoodleBox], a Moodle server installed on a [https://en.wikipedia.org/wiki/Raspberry_Pi Raspberry Pi].

It enables a Moodle administrator to monitor some hardware settings, to set the date of the [https://moodlebox.net MoodleBox], to allow restart and shutdown of the [https://moodlebox.net MoodleBox] and changing Raspberry Pi passwords using a GUI. After the installation in Moodle, some steps are required to complete on the Raspberry Pi (see below).

The plugin is compatible with Moodle 3.6 or later. A Raspberry Pi model 3A+, 3B, 3B+ or 4B is recommended.

== Requirements ==

* A [https://en.wikipedia.org/wiki/Raspberry_Pi Raspberry Pi] (Model 3A+, 3B, 3B+ or 4B recommended)
* [https://en.wikipedia.org/wiki/Raspbian Raspbian] installed (or another Linux based distribution)
* Package Incron installed
* Moodle installed (obviously)

== Installation==

The MoodleBox plugin must be installed in the Moodle tree of the [https://moodlebox.net MoodleBox], in the tool folder. Once installed, an new option MoodleBox will be available in Moodle, under ''Site administration > Server'' in the Administration block.

To complete the installation, you have to configure some `direvent` jobs on the MoodleBox.

1. Install `direvent` package:
```bash
sudo apt-get install direvent
```

1. Add following lines to file `/etc/direvent.conf`:
```bash
# This is the configuration file for direvent. Read
# direvent.conf(5) for more information about how to
# fill this file.

debug 0;

watcher {
path /var/www/moodle/admin/tool/moodlebox/;
file .reboot-server;
event CLOSE_WRITE;
command "/sbin/shutdown -r now";
}

watcher {
path /var/www/moodle/admin/tool/moodlebox/;
file .shutdown-server;
event CLOSE_WRITE;
command "/sbin/shutdown -h now";
}

watcher {
path /var/www/moodle/admin/tool/moodlebox/;
file .set-server-datetime;
event CLOSE_WRITE;
command "/bin/bash /var/www/moodle/admin/tool/moodlebox/.set-server-datetime";
}

watcher {
path /var/www/moodle/admin/tool/moodlebox/;
file .newpassword;
event CLOSE_WRITE;
command "/bin/bash /var/www/moodle/admin/tool/moodlebox/bin/changepassword.sh";
}

watcher {
path /var/www/moodle/admin/tool/moodlebox/;
file .wifisettings;
event CLOSE_WRITE;
command "/usr/bin/python3 /var/www/moodle/admin/tool/moodlebox/bin/changewifisettings.py";
}

watcher {
path /var/www/moodle/admin/tool/moodlebox/;
file .resize-partition;
event CLOSE_WRITE;
command "/bin/bash /var/www/moodle/admin/tool/moodlebox/bin/resizepartition.sh";
}
```

=== Copy the following line at the end of file /etc/sudoers ===
www-data ALL=(ALL) NOPASSWD:/sbin/parted /dev/mmcblk0 unit MB print free

=== [[Secure Moodle on Raspberry Pi Model 2, Gentoo Linux and Nginx server|Secure your Moodlebox]] ===

This is not needed in normal MoodleBox use, i.e. if you don't expose your MoodleBox on the Internet.

== Features ==

* Info about the MoodleBox (kernel version, Raspbian version, free space on SD card, CPU load, CPU temperature, CPU frequency, uptime, DHCP clients).
* GUI to set the MoodleBox date and time.
* GUI to set the MoodleBox password.
* GUI to set the MoodleBox Wi-Fi network password, SSID and channel.
* GUI to restart and shutdown the MoodleBox.

== Availability ==

The code is available at [https://github.com/moodlebox/moodle-tool_moodlebox https://github.com/moodlebox/moodle-tool_moodlebox].

== See also ==

* [https://moodlebox.net MoodleBox documentation]

[[Category:Contributed code]]

[[es:MoodleBox]]

admin/environment/php extension/sodium

2021-05-20T09:54:06Z

Mina: Undo revision 140482 by Mina (talk)

#REDIRECT [[Environment - PHP extension sodium]]

admin/environment/php extension/sodium

2021-05-20T09:53:18Z

Mina: Redirected page to Environnement - Extension PHP sodium

#REDIRECT [[Environnement - Extension PHP sodium]]

Switch roles

2021-03-13T14:38:26Z

Mina: Fix link

{{Capabilities}}
==Switching temporarily to another role==

The switch roles feature allows a user to switch temporarily to another role from the user menu 'Switch role' so that they can see what the course would look like to someone with that role.

[[File:SwitchRoleUserMenu.png]]

Switching roles is not perfect because you remain the same user, and your user may not have things like grades, which will make some student views look different than a real student might see. To get an 100% accurate view, the best thing to do is create a test student account and enrol it in your course. It is useful to have this logged-in on another browser so you can quickly switch back and forth.

The capability moodle/role:switchroles is required for the role so you can see the role switch in the user menu. The capability is allowed for the default roles of manager and teacher.

Another way to see a student view is to "Log in as" one of your real students. You need the special capability [[Capabilities/moodle/user:loginas|user:loginas]] for this, and you do need to be careful that you don't accidentally change things for that student.

==Site administration settings==

The list of roles that you can switch to is set in the "Allow role switches" tab in 'Define roles' in the site administration.

==Enabling a non-editing teacher to switch roles==

# Go to Site administration / Users / Permissions / Define roles and click the 'Allow role switches' tab.
# For the non-editing teacher row, make sure that the checkboxes for Student and Guest are ticked.
# Save changes.
# Click the 'Manage roles' tab and edit the non-editing teacher role.
# Enter 'switch' in the filter field, then tick the checkbox to allow the capability 'Switch to other roles' (moodle/role:switchroles).
# Save changes.

==See also==

*[[Managing roles]]
*The capability [[Capabilities/moodle/user:loginas|moodle/user:loginas]]

[[Category:Capabilities|Role]]
[[Category:Roles]]

[[es:Cambiar roles]]
[[de:Rollen wechseln]]
[[fr:Prendre le rôle]]
[[ja:ケイパビリティ/moodle/role:switchroles]]

Capabilities/mod/data:exportentry

2020-09-17T09:15:09Z

Mina:

{{Capabilities}}
*This allows a user to export [[Database activity module]] entries
*This capability is allowed for the default roles of manager, teacher and non-editing teacher

Tip: The ##export## tag should be added to list and/or single templates.

[[Category:Capabilities|Database]]
[[Category:Database activity module]]

[[es:Capabilities/mod/data:exportentry]]
[[de:Capabilities/mod/data:exportentry]]
[[fr:Capabilities/mod/data:exportentry]]

Moodle XML format

2020-07-29T12:13:59Z

Mina: /* Useful utilities */

{{Export questions}}
The XML Format is a Moodle-specific format for importing and exporting questions to be used with the [[Quiz module]]. The format has been developed within the Moodle Community but other software may support it to a greater or lesser degree.

==A word about validity (and CDATA)==

The XML parser assumes that the XML file is well formed and does not detect or report errors. If it is not you are very likely to get unexpected errors. If you are hand-coding the XML file it is strongly recommended that you pass it through some sort of XML verifier before importing into Moodle. A simple way to do this is to open the XML file using Firefox or Internet Explorer.

Note particularly that embedded HTML fragments should be within [http://en.wikipedia.org/wiki/CDATA CDATA sections]. CDATA example:

<code xml>
<questiontext format="html">
<text><![CDATA[
Now I can include <strong>any</strong> HTML that I<br />
wish. Without the CDATA, the <i>HTML</i> tags would break
the XML!!
]]>
</text>
</questiontext>
</code>

==Overall structure of XML file==

The file is enclosed by tags as follows. It is '''important''' to make sure the xml tag only is really the first line of the file. A blank first line, or additional tags on the first line will confuse the Moodle XML parser.

<code xml>
<?xml version="1.0" ?>
<quiz>
.
.
.
</quiz>
</code>

Within the <quiz> tags are any number of <question> tags. One of these <question> tags can be a dummy question with a ''category'' type to specify a category for the import/export.

<code xml>
<question type="category">
<category>
<text>$course$/XXXX</text>
</category>
</question>
</code>

Where XXXX is the new category name. If the category exists, the question(s) will be added to the existing course; otherwise a new category will be created. This only works if you have "Get category from file" checked.

Multiple categories can be specified in the same file. Just add another dummy 'category' question each time you would like to establish a new category and the questions that follow it will be placed there.

The file must be encoded in [[UTF8]]

Moodle XML import and export are balanced in functionality, so if you need to understand the format you can simply create some questions and export them to see what it looks like.

==Tags common to all question types==

A question is written as follows.

<code xml>
<question type="multichoice|truefalse|shortanswer|matching|cloze|essay|numerical|description">
<name>
<text>Name of question</text>
</name>
<questiontext format="html">
<text>What is the answer to this question?</text>
</questiontext>
.
.
.
</question>
</code>

Each question requires a <name> tag and <question-text> tag for the XML file to import into Moodle properly.

"Format" selects the [[Formatting options]] for the question text. The options are '''html''' (the default), '''moodle_auto_format''', '''plain_text''' and '''markdown'''. The choice effects the way in which the text will be displayed.

Further tags, which usually include at least one <answer> tag, follow in the space marked with dots as child nodes to the <question> tag. The response-related tags are listed further down on this page. Various (optional?) tags are possible.

* tags (non-hierarchical keywords)
* penalty
* generalfeedback
* defaultgrade
* hidden

Even though question tags (non-hierarchical keyowords) are not fully supported in the question engine, they can be imported and exported via XML.

<code xml>
<question ...>
...
<tags>
<tag>
<text>keyword1</text>
</tag>
<tag>
<text>keyword2</text>
</tag>
...
</tags>
...
</question>
</code>

The <image> tag contains the url of any included image. Nested within the <image> tag may be an <image_base64> tag which contains the actual image data encoded in base64 [http://www.php.net/manual/en/function.base64-encode.php].

{{Note|If you export questions from a Moodle 1.9 server, the exported file might contain only the relative URL to the image hosted in the 1.9 server, while exported questions from Moodle 2.x and 3.x servers might contain the actual image encoded in base 64. This explains why some question bank import-export operations include all the images and some others don't.}}
'''In the following question type examples the common parts of the question are not shown to improve clarity. It's a good idea to export some examples yourself to see a full example.'''

==Multiple choice==

MC questions have one <answer> tag for each choice. Each choice can carry feedback and score weighting (by using the fraction attribute). In addition, an MC question has the following tags:

* single ''(values: true/false)''
* shuffleanswers ''(values: 1/0)''
* correctfeedback
* partiallycorrectfeedback
* incorrectfeedback
* answernumbering (allowed values: 'none', 'abc', 'ABCD' or '123')

The <single> tag is used to distinguish single response (radio button) and multiple response (checkbox) variants.

<code xml>
<question type="multichoice">
<answer fraction="100">
<text>The correct answer</text>
<feedback><text>Correct!</text></feedback>
</answer>
<answer fraction="0">
<text>A distractor</text>
<feedback><text>Ooops!</text></feedback>
</answer>
<answer fraction="0">
<text>Another distractor</text>
<feedback><text>Ooops!</text></feedback>
</answer>
<shuffleanswers>1</shuffleanswers>
<single>true</single>
<answernumbering>abc</answernumbering>
</question>
</code>

== True/false ==

Two answer tags are given, one which is true, and one which is false. The fraction attribute of the answer tag identifies which option is correct (100) and which is false (0). Feedback is supported. The following example shows the format when true is the correct answer and false is wrong.

<code xml>
<question type="truefalse">
<answer fraction="100">
<text>true</text>
<feedback><text>Correct!</text></feedback>
</answer>
<answer fraction="0">
<text>false</text>
<feedback><text>Ooops!</text></feedback>
</answer>
</question>
</code>

== Short answer ==

The short answer question type supports alternative correct responses, each with its own weighting and feedback. The Moodle XML format uses one <answer> tag for each of the alternative correct answers.

The <usecase> tag toggles case-sensitivity with the values 1/0.

<code xml>
<question type="shortanswer">
<answer fraction="100">
<text>The correct answer</text>
<feedback><text>Correct!</text></feedback>
</answer>

<question type="shortanswer">
<answer fraction="100">
<text>The correct answer</text>
<feedback><text>Correct!</text></feedback>
</answer>
<answer fraction="100">
<text>An alternative answer</text>
<feedback><text>Correct!</text></feedback>
</answer>
</question>
</code>

== Numerical response ==

The following is a simplified version of the Moodle XML format for numerical responses.

<code xml>
<question type="numerical">
<answer fraction="100">
<text>23</text>
<feedback><text>Feedback</text></feedback>
</answer>
</question>
</code>

Moodle also supports a <tolerance> tag (how accurate must the number be?) and one or more <unit> tags. Unit tags have names and multipliers. E.g. if the main answer is in kilometres, an additional answer could be the equivalent in metres with a multiplier of 1000.

'''Note:''' prior to 1.7.2 the fraction was expressed as a value between 0 and 1 in a <fraction> element and the answer value was '''not''' enclosed in <text> tags. This format of the numerical question type is deprecated but will still be correctly imported if found (for now).

== Matching ==

Pair matching responses use the <shuffleanswers> tag to determine whether the order of the items should be randomized.
Each pair is contained inside a <subquestion> tag. The first item of each pair is contained with a <text> tag, while the second has an <answer> tag around it as well. Feedback and score weighting is not supported by Moodle for this response type.

<code xml>
<question type="matching">
<subquestion>
<text>This is the 1st item in the 1st pair.</text>
<answer>
<text>This is the 2nd item in the 1st pair.</text>
</answer>
</subquestion>
<subquestion>
<text>This is the 1st item in the 2nd pair.</text>
<answer>
<text>This is the 2nd item in the 2nd pair.</text>
</answer>
</subquestion>
<shuffleanswers>true</shuffleanswers>
</question>
</code>

== Essay ==

An example of the essay type question...

<code xml>
<question type="essay">
<answer fraction="0">
<text></text>
</answer>
</question>
</code>

There isn't an answer and there isn't a grade in this case.

'''Note:''' prior to 1.7.2 the fraction was expressed as a value between 0 and 1 in a <fraction> element and the answer value was '''not''' enclosed in <text> tags. This format of the essay question type is deprecated but will still be correctly imported if found (for now).

== Other question types ==

=== Cloze ===

It is supported, and depends on a special format for the <questiontext> tag.

=== Description response type===

This response type has no further tags other than those contained in the question header (such as <questiontext>).

=== Random matching ===

Moodle has a question type which consists of taking short answer questions in the same quiz and displaying them as a pair matching exercise. However Moodle is neither able to export nor import this question type.

==Text formats==

Moodle XML files should explicity specify the text format ('''html''', '''moodle_auto_format''', '''plain_text''' and '''markdown''' - these correspond to the constants , FORMAT_HTML, FORMAT_MOODLE, etc used in the Moodle code) for each piece of content. Note that, by default, the format should be specified on the parent of the <text> element. This is slightly odd, but a remnant of history.

If the format is not specified for the questiontext, then '''html''' is the default. If the format is not specified on any other part of the question, then the format of the questiontext is the default.

(This default changed around November 2011. Before that, the default was '''moodle_auto_format''' whenever the format was not specified.)

==Useful utilities==
*[https://moodle.org/plugins/qformat_crossxml Cross XML format] This input format plugin is a handy utility that converts question from one question type to another.
*[http://vletools.com Online Moodle XML converter] Convert from existing text files glossaries and quizzes to Moodle XML format. Also can convert from Moodle XMl to text.
*[https://moodle.org/mod/forum/discuss.php?d=398452 R script for converting spreadsheet quiz questions into Moodle XML] - This is an R script to turn a spreadsheet with quiz questions into a Moodle XML file. I included an example spreadsheet. I wrote up a quick start guide, but I can only upload two files. Feel free to modify for personal use. If you make useful modifications, please share them with me. I have only written support for multichoice (single correct answer), shortanswer, or truefalse question types. I have only tested this with Moodle 3.7
*[http://www.R-exams.org/ R/exams] is a one-for-all exams generator that can export Moodle XML (among various other output formats) from potentially dynamic exercises written in R/Markdown or R/LaTeX. A brief tutorial for Moodle is available at: [http://www.R-exams.org/tutorials/elearning/ E-Learning Quizzes with R/exams for Moodle and OpenOLAT].

== See also ==

*[[Aiken format]]
*[[XML FAQ]]
*[[Import and export FAQ]]
* [[User:Frank Ralf/Moodle XML1]] (work in progress)

[[ja:Moodle XMLフォーマット]]
[[de: Moodle XML-Format]]
[[fr:Format XML Moodle]]
[[es:Formato Moodle XML]]

Performance

2020-06-19T08:02:18Z

Mina: Add link

{{Managing a Moodle site}}
*[[Performance recommendations]]
*[[Performance settings]]
*[[Performance overview]]
*[[Caching]]
*[[How to check your database for corruption]]

==See also==
*[[Performance FAQ]]
*[[MUC FAQ]]

[[Category:Performance]]

[[de:Geschwindigkeit]]
[[es:Desempeño]]
[[it:Prestazioni]]
[[fr:Performance]]

Security report on default user role

2020-05-15T13:09:23Z

Mina: /* Default user role is incorrectly defined */ Removing wrong addition. Sorry for the spam.

{{Security overview report}}
==Default role for all users==

In general the default role for all users should be set to authenticated user. Normally all permissions for the role of authenticated user should be left as default.

==Default user role is incorrectly defined==

If the security overview report shows the default role for all users with status 'Critical' and states that 'The default user role "Authenticated user" is incorrectly defined!' it means that one or more risky capabilities are allowed for the role.

==Reviewing authenticated user role permissions==

The permissions for the role of authenticated user can be reviewed as follows:

# Go to ''Administration > Site administration > Users > Permissions > Define roles''
# In the role column, click the link 'Authenticated user'
# Browse the permissions column

If there is no reason for changing permissions from default, then the role can be reset by clicking the Reset button at the top of the page.

[[File:ResetRoleButton.jpg]]

After resetting the authenticated user role, the security overview report will show the default role for all users with status OK.

==See also==

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

[[es:Reporte de seguridad sobre rol del usuario por defecto]]

Security report on default user role

2020-05-15T13:01:59Z

Mina: Add a precision

{{Security overview report}}
==Default role for all users==

In general the default role for all users should be set to authenticated user. Normally all permissions for the role of authenticated user should be left as default.

==Default user role is incorrectly defined==

If the security overview report shows the default role for all users with status 'Critical' and states that 'The default user role "Authenticated user" is incorrectly defined!' it means that one or more risky capabilities are allowed for the role.

This is e.g. the case when mobile web services are enabled on a site (for Moodle Mobile app users): the security overview report shows the default role for all users with status 'Critical' due to the webservice capabilities being allowed for the authenticated user role.

==Reviewing authenticated user role permissions==

The permissions for the role of authenticated user can be reviewed as follows:

# Go to ''Administration > Site administration > Users > Permissions > Define roles''
# In the role column, click the link 'Authenticated user'
# Browse the permissions column

If there is no reason for changing permissions from default, then the role can be reset by clicking the Reset button at the top of the page.

[[File:ResetRoleButton.jpg]]

After resetting the authenticated user role, the security overview report will show the default role for all users with status OK.

==See also==

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

[[es:Reporte de seguridad sobre rol del usuario por defecto]]

Creating custom roles

2020-05-07T09:20:53Z

Mina: /* See also */ Typo

{{Roles}}
==Creating a new role==

To create a custom role:
#Go to ''Administration > Site administration > Users > Permissions > Define roles''.
#Click the "Add a new role" button.
#If desired, select an existing role or upload a preset, otherwise click the continue button.
#Give the role a Short name e.g. 'Parent'.The short name is necessary for other plugins in Moodle that may need to refer to the role (e.g. when uploading users from a file or setting enrolments via an enrolment plugin).
#You must provide a full name for all custom roles. If you need to name the role for multiple languages you can use [[Multi language content|multi-lang syntax]] if you wish.
#Give the role a description (optional).
#Select an appropriate role archetype (see below for further information).
#Select the contexts where the role may be assigned e.g. 'User' for Parent role.
#Set permissions as required.
#Scroll to the top or bottom of the page and click the "Create this role" button.

{|
|-
| [[Image:addinganewrole26.png|thumb|Adding a new role and setting context types]]
| [[Image:permissions125.png|thumb|Choose "Allow" where required]]
| [[Image:permissions225.png|thumb|Extra options with "Show advanced" enabled]]
|-
|}

==Role archetypes==

A role archetype

* Is a hard-coded template for a role
* Is used during upgrades when adding defaults for new capabilities - no archetype = no new capabilities during upgrade
* Is used during when resetting a role to determine the defaults - no archetype = reset removes all capabilities

There is no need to set a role archetype for custom roles used for overrides or if the site admin wants to specify new capabilities manually after upgrading.

The archetypes (which relate directly to the built-in roles) are:
* Manager
* Course creator
* Teacher (editing)
* Teacher (non-editing)
* Student
* Guest
* Authenticated user
* Authenticated user on frontpage

==Creating a duplicate role==

To create a duplicate role:
#Go to ''Administration > Site administration > Users > Permissions > Define roles''.
#Click the "Add a new role" button.
#Select existing role as a template
#Give a name and set permissions for your new role; scroll down and click "Create this role".

==New role considerations==

A new role is not automatically listed in course descriptions even if was created by copying a role that is listed, such as Teacher. If you want the new role to appear in the course listing, you must set it explicitly via ''Administration > Site administration > Appearance > Courses>Course Contacts"

==Testing a new role==
''Administration > Switch role to''
Use the "Switch role to" link to see what another role will see in that context.

Since switching roles confines you to those roles you can assign in a course context, this method is only useful for testing course-scoped capabilities (i.e. it will not be useful for testing permissions that apply outside the course context, like moodle/user:edit).

''Tip:'' You can always create test user and assign the new role to them. Then logout as admin and login as the test user. This is really the best way to test a new role.

==Example custom roles==

*[[Parent role|Parent]] - for providing parents/mentors/tutors with permission to view certain information about their children/mentees/tutees
*[[Demo teacher role|Demo teacher]] - for providing a demonstration teacher account with a password which can't be changed
*[[Forum moderator role|Forum moderator]] - for providing a user with permission in a particular forum to edit or delete forum posts, split discussions and move discussions to other forums
*[[Forum poster role]] - a highly restricted custom role which may be given to a visitor account to enable them to post in forums in a guest access course.
*[[Calendar editor role|Calendar editor]] - for enabling a user to add site or course events to the calendar
*[[Blogger role|Blogger]] - for limiting blogging to specific users only
*[[Quiz user with unlimited time role|Quiz user with unlimited time]] - for allowing a user unlimited time to attempt a quiz which has a time limit set
*[[Question creator role|Question creator]] - for enabling students to create questions for use in quizzes
*[[Question sharer]] - for allowing teachers to share questions between courses
*[[Course requester role]] - for restricting users who can make course requests
*[[Feedback template creator]] - for allowing teachers to save as "Public" a Feedback template.
*[[Grading forms publisher]] - for allowing teachers to share Advanced grading forms with others
*[[Grading forms manager]] - for allowing teachers to share Advanced grading forms with others and to delete templates others have created.
*[[Grade viewer]] - for allowing users to view but not edit grades.
*[[Gallery owner role]] - may be used to provide editing capabilities (add and edit gallery images) to users on individual Lightbox Galleries.
*[[Course tagger]] - for allowing users other than managers and editing teachers to tag courses.
*[[Competency reviewer]] - for allowing teachers to review competencies.
*[[Learning plan supervisor]] for allowing teachers to create learning plans for their own students.
*[[Learning plan viewer]] for allowing teachers to view the learning plans of their own students.
*[[Roles_FAQ#How_can_I_allow_a_.22test.22_Student_user_to_see_courses_that_are_hidden.3F|Student tester ]] - a clone of the default [[Student role]] with the ability to see hidden courses set to Allow.
*[[Privacy Officer role|Privacy Officer]] - A Privacy Officer can respond to data requests and manage the data registry
*[[Researcher role]] - Researchers at Moodle-using institutions can be supported by creating a special Role at the site level with capabilities specific to researchers.

==Uploading users to a system role==

Where certain custom roles are applied in the system context, it is possible to upload users to that role in bulk by adding the field ''sysrole1'' (etc) to the CSV file

==See also==
* [https://github.com/3-bits/moodle-role_sepe SEPE] Spanish government supervisor who can access all Moodle courses without being able to change anything.

Using Moodle forum discussions:
* [https://moodle.org/mod/forum/discuss.php?d=384769&parent=1551206#p1551220 'Observer', a limited Manager role]
* [http://moodle.org/mod/forum/discuss.php?d=66782 What happens if a user has multiple roles in a course?]
* [http://moodle.org/mod/forum/discuss.php?d=90140 logged in: what role am I?]
* For more information, Ask questions and get answers on the [http://moodle.org/mod/forum/view.php?id=6826 "Roles and Permissions"] forum.

[[Category:Site administration]]

[[de:Neue Rollen anlegen]]
[[es:Crear roles personalizados]]
[[fr:Création_de_rôles_personnalisés]]
[[ja:カスタムロールの作成]]

Creating custom roles

2020-05-07T09:20:14Z

Mina: /* See also */ Fix syntax

{{Roles}}
==Creating a new role==

To create a custom role:
#Go to ''Administration > Site administration > Users > Permissions > Define roles''.
#Click the "Add a new role" button.
#If desired, select an existing role or upload a preset, otherwise click the continue button.
#Give the role a Short name e.g. 'Parent'.The short name is necessary for other plugins in Moodle that may need to refer to the role (e.g. when uploading users from a file or setting enrolments via an enrolment plugin).
#You must provide a full name for all custom roles. If you need to name the role for multiple languages you can use [[Multi language content|multi-lang syntax]] if you wish.
#Give the role a description (optional).
#Select an appropriate role archetype (see below for further information).
#Select the contexts where the role may be assigned e.g. 'User' for Parent role.
#Set permissions as required.
#Scroll to the top or bottom of the page and click the "Create this role" button.

{|
|-
| [[Image:addinganewrole26.png|thumb|Adding a new role and setting context types]]
| [[Image:permissions125.png|thumb|Choose "Allow" where required]]
| [[Image:permissions225.png|thumb|Extra options with "Show advanced" enabled]]
|-
|}

==Role archetypes==

A role archetype

* Is a hard-coded template for a role
* Is used during upgrades when adding defaults for new capabilities - no archetype = no new capabilities during upgrade
* Is used during when resetting a role to determine the defaults - no archetype = reset removes all capabilities

There is no need to set a role archetype for custom roles used for overrides or if the site admin wants to specify new capabilities manually after upgrading.

The archetypes (which relate directly to the built-in roles) are:
* Manager
* Course creator
* Teacher (editing)
* Teacher (non-editing)
* Student
* Guest
* Authenticated user
* Authenticated user on frontpage

==Creating a duplicate role==

To create a duplicate role:
#Go to ''Administration > Site administration > Users > Permissions > Define roles''.
#Click the "Add a new role" button.
#Select existing role as a template
#Give a name and set permissions for your new role; scroll down and click "Create this role".

==New role considerations==

A new role is not automatically listed in course descriptions even if was created by copying a role that is listed, such as Teacher. If you want the new role to appear in the course listing, you must set it explicitly via ''Administration > Site administration > Appearance > Courses>Course Contacts"

==Testing a new role==
''Administration > Switch role to''
Use the "Switch role to" link to see what another role will see in that context.

Since switching roles confines you to those roles you can assign in a course context, this method is only useful for testing course-scoped capabilities (i.e. it will not be useful for testing permissions that apply outside the course context, like moodle/user:edit).

''Tip:'' You can always create test user and assign the new role to them. Then logout as admin and login as the test user. This is really the best way to test a new role.

==Example custom roles==

*[[Parent role|Parent]] - for providing parents/mentors/tutors with permission to view certain information about their children/mentees/tutees
*[[Demo teacher role|Demo teacher]] - for providing a demonstration teacher account with a password which can't be changed
*[[Forum moderator role|Forum moderator]] - for providing a user with permission in a particular forum to edit or delete forum posts, split discussions and move discussions to other forums
*[[Forum poster role]] - a highly restricted custom role which may be given to a visitor account to enable them to post in forums in a guest access course.
*[[Calendar editor role|Calendar editor]] - for enabling a user to add site or course events to the calendar
*[[Blogger role|Blogger]] - for limiting blogging to specific users only
*[[Quiz user with unlimited time role|Quiz user with unlimited time]] - for allowing a user unlimited time to attempt a quiz which has a time limit set
*[[Question creator role|Question creator]] - for enabling students to create questions for use in quizzes
*[[Question sharer]] - for allowing teachers to share questions between courses
*[[Course requester role]] - for restricting users who can make course requests
*[[Feedback template creator]] - for allowing teachers to save as "Public" a Feedback template.
*[[Grading forms publisher]] - for allowing teachers to share Advanced grading forms with others
*[[Grading forms manager]] - for allowing teachers to share Advanced grading forms with others and to delete templates others have created.
*[[Grade viewer]] - for allowing users to view but not edit grades.
*[[Gallery owner role]] - may be used to provide editing capabilities (add and edit gallery images) to users on individual Lightbox Galleries.
*[[Course tagger]] - for allowing users other than managers and editing teachers to tag courses.
*[[Competency reviewer]] - for allowing teachers to review competencies.
*[[Learning plan supervisor]] for allowing teachers to create learning plans for their own students.
*[[Learning plan viewer]] for allowing teachers to view the learning plans of their own students.
*[[Roles_FAQ#How_can_I_allow_a_.22test.22_Student_user_to_see_courses_that_are_hidden.3F|Student tester ]] - a clone of the default [[Student role]] with the ability to see hidden courses set to Allow.
*[[Privacy Officer role|Privacy Officer]] - A Privacy Officer can respond to data requests and manage the data registry
*[[Researcher role]] - Researchers at Moodle-using institutions can be supported by creating a special Role at the site level with capabilities specific to researchers.

==Uploading users to a system role==

Where certain custom roles are applied in the system context, it is possible to upload users to that role in bulk by adding the field ''sysrole1'' (etc) to the CSV file

==See also==
* [https://github.com/3-bits/moodle-role_sepe SEPE] Spanish government supervisor who can access all Moodle courses without being able to change anything.

Using Moodle forum discussions:
* [https://moodle.org/mod/forum/discuss.php?d=384769&parent=1551206#p1551220 An 'Observer' role, a limited Manage role.]
* [http://moodle.org/mod/forum/discuss.php?d=66782 What happens if a user has multiple roles in a course?]
* [http://moodle.org/mod/forum/discuss.php?d=90140 logged in: what role am I?]
* For more information, Ask questions and get answers on the [http://moodle.org/mod/forum/view.php?id=6826 "Roles and Permissions"] forum.

[[Category:Site administration]]

[[de:Neue Rollen anlegen]]
[[es:Crear roles personalizados]]
[[fr:Création_de_rôles_personnalisés]]
[[ja:カスタムロールの作成]]

Course requester role

2020-05-06T13:33:48Z

Mina: Link added

{{Roles}}The role of Course requester may be used to restrict users who can make [[Course request|course requests]], perhaps to teachers only.

==Removing the capability to make course requests==

By default, all authenticated users can make course requests. To change this:

#Access ''Administration > Users > Permissions > Define roles''.
#Edit the authenticated user role and change the capability [[Capabilities/moodle/course:request|moodle/course:request]] from allow to not set.
#Scroll to the bottom (or top) of the page and click the 'Save changes' button.

==Role set-up==

#Access ''Administration > Users > Permissions > Define roles''.
#Click the button "Add a new role"
#Give the role a name e.g. Course requester, short name and description.
#Under "Context types where this role may be assigned", click on the "System" tick box turning it on.
#Change the capability moodle/course:request to allow.
#Click the button "Create this role".

''Note'': It is necessary to create a new role, rather than simply changing the capability for the teacher role, because it needs to be assigned as a system role. (The role of teacher is generally assigned in the course or course category context.)

==Role assignment==

#Access ''Administration > Users > Permissions > Assign system roles''.
#Choose the course requester role to assign.
#Select one or more users in the Potential users list, and use the left-facing arrow button to add it to the Existing users list. If you want all your institution's teachers to be able to make course requests, you need to select and add all their names to the Existing users list.

==Add a Course Request block==

Now, this will work fine for those users who already have a Teacher role in at least ONE course on your Moodle site. When they log in, they will see the list of course(s) that they are enrolled in as Teacher(s) plus an All courses button. Clicking on that '''All courses''' button will show the complete list of courses on the site, plus a '''Request a course''' button, which they will be able to click to request a course.

However, those Moodle site users whom we have assigned to the Course requester role in System ''and who do not yet have a Teacher role in at least ONE course on your Moodle site will not see that '''All courses''' button'', since by default all the available courses will be displayed. And consequently, the '''Request a course''' button will not appear to them. To solve this, a further step is required, viz. creating an HTML block on the front page with a direct link to /course/request.php! And of course that block will have to be made invisible to students etc.

# On the front page add a block: HTML: title: ''Course request'' contents: ''Click here to request a course'' with a link to <yourmoodlesite>/course/request.php
# Click the 'Assign roles' link and then in the administration block click the permissions link and edit the permissions so that only users with a Course requester or Teacher role will be able to view that block; students etc. won't see it.

Now Course requesters who are not yet enrolled as Teachers in Courses will be able to see that HTML block, click on the link and request a course. Of course, this block is redundant for those Course requesters who are also Teachers, but it is needed for Teachers requesting the creation of ''their very first course'' on the Moodle site.

==See also==

* [http://moodle.org/mod/forum/discuss.php?d=195211 Only teachers can request courses - how to do that?] forum discussion

[[es:Rol de solicitante de curso]]
[[ja:コースリクエストロール]]
[[fr:Rôle_Demandeur_de_cours]]

Language customisation

2020-04-21T14:30:02Z

Mina: Fix link to french doc

{{Language}}
==Changing words or phrases==

Words or phrases (in any language) used on the site may be easily changed by an administrator using the language customisation feature. For example, you may want to change the word "Course" to "Unit".

# Go to ''Site administration > Language > Language customisation'' and choose the language you wish to customise.
# Click the "Open language pack for editing" button. (This may take some time to process.)
# Once the language pack has loaded, click the "Continue" button.
# Find the string you wish to customise using the filter settings, then clicking "Show strings". See below for details of how to find the component and string identifier.
# Make your changes in the "Local customisation" box.
# Click "Apply changes and continue editing" if you want to use another filter or edit other file(s), otherwise click "Save changes to the language pack" to save all of the changes you have made.

==Finding the component and string identifier==
* We will use an example where the user wants to replace 'Courses' with 'Assessments' in the Dashboard of Moodle 3.3 Boost theme.
[[File:Lang string origins in Boost theme 01.png|400px|This is the text want to change]]
* Go to ''Site administration > Development > Debugging''.
* Tick the 'Show origin of languages strings' tickbox then save changes.
* Go to the page containing the string you want to customise and in the address bar, append the following to the URL: either <pre>?strings=1</pre> or <pre>&strings=1</pre> (depending whether there is already a parameter).
* Reload the page.

[[File:Lang string origins in Boost theme 02.png|400px|These are the strings we need to change]]

* The page will then be displayed with component and string identifies in curly brackets after each string, for example "{nocourses/block_myoverview}". The first part, before the /, is the string identifier. The last part is the component e.g block_myoverview.php. If there is nothing after the / (e.g. "{courses/}" ) then the string is in moodle.php.
* You will then use this information to customize your language strings.

===Using the obtained information in order to change the intended strings===

# Go to ''Site administration > Language > Language customization''.
# Choose the English (en) language pack.
# Open language pack for editing.
# Click on the 'Continue' button.
# Select the moodle.php component (in this particular case)
# Type courses as the string identifier (in this case)
# Click on the 'Show strings' button
# Type your locally customized string, replacing 'Courses' with 'Assessments'.

[[File:Lang string origins in Boost theme 03.png|400px|We will replace 'Courses' with 'Assessments']]

* After saving the changes into the language pack, you can check that you achieved the intended change:
[[File:Lang string origins in Boost theme 04.png|400px|We have replaced 'Courses' with 'Assessments']]

* Remember to always check that you have only changed the intended strings in the intended places.
* Repeat the procedure with all the strings that you want changed (e.g. course, no courses,...)
* Clear language string caches by going to ''Site administration > Development > Purge all caches''.

==Filter settings==

[[Image:Language_string_M2_filter.png|thumb|Language filter]]

* ''Show strings of these components'' - Click or Ctrl+click to select one or more files.
* ''Customised only'' - tick the box to display only those strings that are already present in your xx_local pack.
* ''Help only''' - tick the box to display only help strings, that is the texts used when clicking the yellow question mark icon.
* ''Modified only'' - tick the box to display only the strings that are modified since the last checked in string into the language pack.
* ''Only strings containing'' - insert a phrase that must appear in the string. For example, if you put a word 'student' here, you will get only those strings that contain this word.
* ''String identifier'' - see above.

==Local customisation highlighting==

* Customised strings (already saved in a file) are highlighted in green.
* Modified strings (not saved in a file yet) are highlighted in blue.
* Customised strings for deletion are highlighted in red.

== More about language packs ==

Moodle is translated into many languages - see [https://download.moodle.org/langpack/{{Version}}/ Language packs for Moodle {{Version}}] for their list and the translation completion status. The translations are distributed as language packages (or just lang packs) that are maintained by kind volunteers, community contributors and Moodle Partners.

Moodle site administrators can customise any language pack to fit their individual needs. Editing the language pack files directly is not recommended, since any changes would be silently overwritten during the next upgrade. Instead, you should use the language customisation feature, which automatically creates a local language pack that holds all your changes from the official pack.

Local language packs have the same structure as official ones. They are saved in your Moodle data directory in moodledata/lang/xx_local/ folder where 'xx' is the code of the language. You have to have the official language pack installed before you can customise it. A local language pack should contain just strings you have customised - there is no need to create a copy of a whole official language pack.

When displaying a string, Moodle first looks whether a local customisation exists in moodledata/lang/xx_local/component_file.php. If so, it is used. If not, the string from the official language pack is used. (If the string has not been translated yet, the original English version is displayed). Please note that the strings are cached for better performance so if you modify a file directly in your xx_local pack then you will have to purge Moodle caches afterwards. Caches are purged automatically when using the language customisation feature.

[[image:customlang-process.png|800px|thumb|left|Workflow of the language customisation (click to enlarge)]]
<br clear="both" />

==How to backup and restore a customised language pack==

This is handy when you have made customisations of your language pack and you want to install these changes on another server.

If you customised a language pack xx, the only folder you need to back up is $CFG->dataroot/lang/xx_local. All others without the _local suffix are standard packages that can be installed and uninstalled via the admin tool.

Once the folder is restored on another server, you will have to manually purge caches from the admin interface to allow the in-built string manager to re-read the *_local folders and start using them.

==Sharing a language customisation==

* If you have made a language customisation for a specific need, which is shared by other people (e.g. a kids version of your national language, intended for your school, but also useful for other schools), please consider sharing it as a child language in AMOS.
* If your country uses a language that is not exactly the same as an existing language pack listed in the [http://lang.moodle.org/local/amos/credits.php translation credits], and you have made a customisation that better suits the needs of your fellow country Moodle users, you might want to consider starting a child language pack in AMOS (e.g. Canadian French, which has over 1000 changes from the French parent language).

In either case, contact the parent language pack maintainer listed in the [http://lang.moodle.org/local/amos/credits.php translation credits] and/or our translation coordinator, Koen, [mailto:translation@moodle.org translation@moodle.org].

==Troubleshooting==

===Database error===

[[File:Database error while language customization.png|400px]]
If you encounter a database error when you try to customise a language pack, then it may be due to a recent plugin that corrupted the database. You are advised to check all plugins recently added to your site, and check whether removing a plugin prevents this error. If that is the case, please contact the maintainer for the involved plugin and [https://moodle.org/mod/forum/discuss.php?d=222815 report the error]. Most cases seen in 2013 were fixed by the maintainers of those plugins. [https://moodle.org/mod/forum/discuss.php?d=254464#unread One case seen in 2014] was related to the Essential (additional) theme and language packs other than English; it was caused by a a bug with the notification language handling, and was fixed with a plugin update.

Or, you can [https://moodle.org/mod/forum/discuss.php?d=208012 execute a database query] on your server in order to track down the plugin causing the problem.

==Changing the font size and colour of a language string==

You can use language customization to change the font size and colour for any (core or additional plugin) Moodle string.

See the following example taken from [https://moodle.org/mod/forum/discuss.php?d=351446#p1418409 a Spanish forum] user who wanted to have a distinct large red coloured text for the 'Answer the questions...' prompt in the feedback activity:

[[File:Language customization changing font size and colour.png|600px]]

You could also add an image to a customized language string, as in [https://moodle.org/mod/forum/discuss.php?d=354029#unread this forum post].

==Moodle Mobile language strings customisation==
See [[Moodle_Mobile_guide_for_admins#Custom_language_strings|Custom language strings]] in the Moodle Mobile guide for admins.

== Language customization of langconfig.php file ==

Using language customization for parentlanguage inside langconfig.php in an existing Moodle server, where you add a parent language (while the AMOS parentlanguage string is actually empty) will ask for the installation of said parent language in the server, but will not substitute the missing translations in the child language with those of the parent language; English will be shown.

==See also==

* [https://moodle.org/mod/forum/discuss.php?d=219504 Duplicate entry 'en-373-AM'] forum discussion about error when attempting to edit a lang pack
* [https://moodle.org/mod/forum/discuss.php?d=272950 Changing one word across the whole site] forum discussion

==Any questions?==

Please post in the [https://moodle.org/mod/forum/view.php?id=43 Languages forum] on moodle.org.

[[de:Sprachanpassung]]
[[es:Personalización del idioma]]
[[fr:Personnalisation de la langue]]

Performance recommendations

2020-02-23T22:41:22Z

Mina: /* See also */ Update link to french doc

{{Performance}}
Moodle can be made to perform very well, at small usage levels or scaling up to many thousands of users. The factors involved in performance are basically the same as for any PHP-based database-driven system. When trying to optimize your server, try to focus on the factor which will make the most difference to the user. For example, if you have relatively more users browsing than accessing the database, look to improve the webserver performance.

==Obtain a baseline benchmark==

Before attempting any optimization, you should obtain a baseline benchmark of the component of the system you are trying to improve. For Linux try [http://lbs.sourceforge.net/ LBS] and for Windows use the Performance Monitor. Once you have quantitative data about how your system is performing currently, you'll be able to determine if the change you have made has had any real impact.

The overall aim of adjustments to improve performance is to use RAM (cacheing) and to reduce disk-based activity. It is especially important to try to eliminate swap file usage as much as you can. If your system starts swapping, this is a sign that you need more RAM.

The '''optimization order preference''' is usually: primary storage (more RAM), secondary storage (faster hard disks/improved hard disk configuration), processor (more and faster).

It can be interesting to install and use the [https://moodle.org/plugins/report_benchmark Benchmark plugin] in order to find the bottlenecks of your system that specifically affect Moodle.

==Scalability==

Moodle's design (with clear separation of application layers) allows for strongly scalable setups. (Please check the list of [[Large installations|large Moodle installations]].)

Large sites usually separate the web server and database onto separate servers, although for smaller installations this is typically not necessary.

It is possible to load-balance a Moodle installation, for example by using more than one webserver. The separate webservers should query the same database and refer to the same filestore and cache areas (see [[Caching]]), but otherwise the separation of the application layers is complete enough to make this kind of clustering feasible. Similarly, the database could be a cluster of servers (e.g. a MySQL cluster), but this is not an easy task and you should seek expert support, e.g. from a Moodle Partner.

On very large, load-balanced, systems the performance of the shared components become critical. It's important that your shared file areas are properly tuned and that you use an effective cache (Redis is highly recommended). A good understanding of these areas of system administration should be considered a minimum requirement.

===Server cluster===

Using Moodle forum discussions:

*[http://moodle.org/mod/forum/discuss.php?d=57202 Moodle clustering]
*[http://moodle.org/mod/forum/discuss.php?d=44470 Software load balancing]
*[http://moodle.org/mod/forum/discuss.php?d=49986 TCP load balancing]
*[http://moodle.org/mod/forum/discuss.php?d=88214 Installation for 3000 simultaneous users]

==Hardware configuration==
'''Note''': The fastest and most effective change that you can make to improve performance is to '''increase the amount of RAM on your web server''' - get as much as possible (e.g. 4GB or more). Increasing primary memory will reduce the need for processes to swap to disk and will enable your server to handle more users.
* Better performance is gained by obtaining the best '''processor capability''' you can, i.e. dual or dual core processors. A modern BIOS should allow you to enable hyperthreading, but check if this makes a difference to the overall performance of the processors by using a [http://en.wikipedia.org/wiki/Super_PI CPU benchmarking tool].
* If you can afford them, use '''SCSI hard disks''' instead of SATA drives. SATA drives will increase your system's CPU utilization, whereas SCSI drives have their own integrated processors and come into their own when you have multiple drives. If you must have SATA drives, check that your motherboard and the drives themselves support NCQ (Native Command Queuing).
* Purchase hard disks with a '''low seek time'''. This will improve the overall speed of your system, especially when accessing Moodle's reports.
* Size your '''swap file''' correctly. The general advice is to set it to 4 x physical RAM.
* Use a '''RAID disk system'''. Although there are many different RAID configurations you can create, the following generally works best:
** install a hardware RAID controller (if you can)
** the operating system and swap drive on one set of disks configured as RAID-1.
** Moodle, Web server and Database server on another set of disks configured as RAID-5.
* If your 'moodledata' area is going to be on relatively slow storage (e.g. NFS mount on to a NAS device) you will have performance issues with the default cache configuration (which writes to this storage). See the page on [[Caching]] and choose an alternative. Redis is recommended. Using [https://en.wikipedia.org/wiki/GlusterFS GlusterFS] / [https://en.wikipedia.org/wiki/OCFS2 OCFS2] / [https://en.wikipedia.org/wiki/GFS2 GFS2] on a [https://en.wikipedia.org/wiki/Storage_Area_Network SAN] device and [https://en.wikipedia.org/wiki/Fibre_Channel Fiber Channel] could improve performance (See more info on the Moodle [https://moodle.org/mod/forum/discuss.php?d=214680#p1123124 forum thread], [https://moodle.org/mod/forum/discuss.php?d=310501#p1242382 NFS performance tuing] )
* Use '''gigabit ethernet''' for improved latency and throughput. This is especially important when you have your webserver and database server separated out on different hosts.
* Check the settings on your '''network card'''. You may get an improvement in performance by increasing the use of buffers and transmit/receive descriptors (balance this with processor and memory overheads) and off-loading TCP checksum calculation onto the card instead of the OS.
* Read this [http://moodle.org/mod/forum/discuss.php?d=68579 Case Study] on a server stress test with 300 users.
* See this [http://elearning.sgu.ac.jp/doc/PT/ accompanying report] on network traffic and server loads.
* Also see this SFSU presentation at Educause (using VMWare): [http://www.educause.edu/Resources/AnOpenSourceLMSforaMissionCrit/162843]

==Operating System==
* You can use [http://en.wikipedia.org/wiki/Linux Linux](recommended), Unix-based, Windows or Mac OS X for the server '''operating system'''. *nix operating systems generally require less memory than Mac OS X or Windows servers for doing the same task as the server is configured with just a shell interface. Additionally Linux does not have licensing fees attached, but can have a big learning curve if you're used to another operating system. If you have a large number of processors running SMP, you may also want to consider using a highly tuned OS such as [http://en.wikipedia.org/wiki/Solaris_Operating_Environment Solaris].
* Check your own OS and '''vendor specific instructions''' for optimization steps.
** For Linux look at the [http://linuxperf.sourceforge.net/ Linux Performance Team] site.
** For Linux investigate the hdparm command, e.g. hdparm -m16 -d1 can be used to enable read/write on multiple sectors and DMA. Mount disks with the [https://moodle.org/mod/forum/discuss.php?d=310501#p1242382 "async" and "noatime"] options.
** For Windows set the sever to be optimized for network applications (Control Panel, Network Connections, LAN connection, Properties, File & Printer Sharing for Microsoft Networks, Properties, Optimization). You can also search the [http://technet.microsoft.com/ Microsoft TechNet site] for optimization documents.

==Web server performance==

Installing [http://www.mozilla.com/en-US/ Firefox] and the [https://addons.mozilla.org/en-US/firefox/addon/1843 firebug] extension will allow you to watch the time it takes for each page component to load. Also, the [https://addons.mozilla.org/en-US/firefox/addon/5369 Yslow] extension will evaluate your page against Yahoo's [http://www.skrenta.com/2007/05/14_rules_for_fast_web_pages_by_1.html 14 rules], full text [http://developer.yahoo.com/performance/rules.html Best Practices for Speeding Up Your Web Site], <strike>([http://video.yahoo.com/video/play?vid=1040890 video])</strike> for fast loading websites.

===PHP performance===
* PHP contains a built-in accelerator. Make sure it is enabled.
* Improvements in read/write performance can be improved by putting the cached PHP pages on a [[TMPFS]] filesystem - but remember that you'll lose the cache contents when there is a power failure or the server is rebooted.
* Performance of PHP is better when installed as an '''Apache/IIS6 ISAPI module''' (rather than a CGI). IIS 7.0/7.5 (Windows Server 2008/R2) users should choose a FastCGI installation for best performance.
* Also check the '''memory_limit''' in php.ini. The default value for the memory_limit directive is 128M. On some sites, it may need to be larger - especially for some backup operations.
* Also see [[PHP_settings_by_Moodle_version]]
* Use [http://blog.bitnami.com/2014/06/performance-enhacements-for-apache-and.html PHP-FPM] (with apache).

===Install HowTo===
==== APC ====
* [http://2bits.com/articles/installing-php-apc-gnulinux-centos-5.html APC on CentOS 5.x (linux)]
* [http://fplanque.com/dev/linux/install-apc-php-cache-debian-lenny APC on Debian (linux)]
==== eAccelerator ====
* [http://noveckg.blogspot.com/2010/02/installing-eaccelerator-cache-for-php.html Installing eAccelerator on CentOS 5.x (linux)]
* [https://docs.moodle.org/en/Installing_eAccelerator_In_Ubuntu_Server/ Installing eAccelerator on Ubuntu Server (linux)]
==== MemCached ====
Memcached server (daemon)
* [https://www.tecmint.com/install-memcached-on-centos-7/ Installing Memcached on CentOS 7.x (linux)] (as of php 7.x, only memcached is available)
* [https://www.digitalocean.com/community/tutorials/how-to-install-and-secure-memcached-on-centos-7 How To Install and Secure Memcached on CentOS 7]
* [https://wiki.zimbra.com/wiki/Blocking_Memcached_Attack#Iptables_rules_for_Redhat_based_servers Iptables rules for Redhat based servers]
Memcached PHP 7.1 extension
* [https://dl.iuscommunity.org/pub/ius/stable/CentOS/7/x86_64/repoview/php71u-pecl-memcached.html php71u-pecl-memcached] from IUS CentOS 7.x repository.

===Apache performance===
* If you are using Apache on a Windows server, use the build from [http://www.apachelounge.com Apache Lounge] which is reported to have [http://moodle.org/mod/forum/discuss.php?d=93358 performance and stability improvements] compared to the official Apache download. Note that this is an unofficial build, so may not keep up with official releases.
* Set the '''MaxRequestWorkers''' directive correctly ('''MaxClients''' before Apache 2.4). Use this formula to help (which uses 80% of available memory to leave room for spare):
MaxRequestWorkers = Total available memory * 80% / Max memory usage of apache process
:Memory usage of apache process is usually 10MB but Moodle can easily use up to 100MB per process, so a general rule of thumb is to divide your available memory in megabytes by 100 to get a conservative setting for MaxClients. You are quite likely to find yourself lowering the MaxRequestWorkers from its default of 150 on a Moodle server. To get a more accurate estimate read the value from the shell command:
#ps -ylC httpd --sort:rss

:If you need to increase the value of '''MaxRequestWorkers''' beyond 256, you will also need to set the '''ServerLimit''' directive.

:'''Warning''': Do not be tempted to set the value of MaxRequestWorkers higher than your available memory as your server will consume more RAM than available and start to swap to disk.
* Consider reducing the '''number of modules''' that Apache loads in the httpd.conf file to the minumum necessary to reduce the memory needed.
* Use the '''latest version of Apache''' - Apache 2 has an improved memory model which reduces memory usage further.
* For Unix/Linux systems, consider lowering '''MaxConnectionsPerChild''' ('''MaxRequestsPerChild''' before Apache 2.4) in httpd.conf to as low as 20-30 (if you set it any lower the overhead of forking begins to outweigh the benefits).
* For a heavily loaded server, consider setting '''KeepAlive Off''' (do this only if your Moodle pages do not contain links to resources or uploaded images) or lowering the '''KeepAliveTimeout''' to between 2 and 5. The default is 15 (seconds) - the higher the value the more server processes will be kept waiting for possibly idle connections. A more accurate value for KeepAliveTimeout is obtained by observing how long it takes your users to download a page. After altering any of the KeepAlive variables, monitor your CPU utilization as there may be an additional overhead in initiating more worker processes/threads.
* As an alternative to using KeepAlive Off, consider setting-up a '''Reverse Proxy server''' infront of the Moodle server to cache HTML files with images. You can then return Apache to using keep-alives on the Moodle server.
* If you do not use a .htaccess file, set the '''AllowOverride''' variable to AllowOverride None to prevent .htaccess lookups.
* Set '''DirectoryIndex''' correctly so as to avoid content-negotiation. Here's an example from a production server:
DirectoryIndex index.php index.html index.htm
* Unless you are doing development work on the server, set '''ExtendedStatus Off''' and disable mod_info as well as mod_status.
* Leave '''HostnameLookups Off''' (as default) to reduce DNS latency.
* Consider reducing the value of '''TimeOut''' to between 30 to 60 (seconds).
* For the '''Options directive''', avoid Options Multiviews as this performs a directory scan. To reduce disk I/O further use
Options -Indexes FollowSymLinks

* Compression reduces response times by reducing the size of the HTTP response
# Install and enable mod_deflate - refer to documentation or man pages
# Add this code to the virtual server config file within the <directory> section for the root directory (or within the .htaccess file if AllowOverrides is On):
<ifModule mod_deflate.c>
AddOutputFilterByType DEFLATE text/html text/plain text/xml text/x-js text/javascript text/css application/javascript
</ifmodule>
* Use Apache [http://blog.bitnami.com/2014/06/performance-enhacements-for-apache-and.html event] [http://httpd.apache.org/docs/current/mpm.html MPM] (and not the default Prefork or Worker)

===IIS performance===
All alter this location in the registry:
HKLM\SYSTEM\CurrentControlSet\Services\Inetinfo\Parameters\
* The equivalent to KeepAliveTimeout is '''ListenBackLog''' (IIS - registry location is HKLM\ SYSTEM\ CurrentControlSet\ Services\ Inetinfo\ Parameters). Set this to between 2 to 5.
*Change the '''MemCacheSize''' value to adjust the amount of memory (Mb) that IIS will use for its file cache (50% of available memory by default).
*Change the '''MaxCachedFileSize''' to adjust the maximum size of a file cached in the file cache in bytes. Default is 262,144 (256K).
*Create a new DWORD called '''ObjectCacheTTL''' to change the length of time (in milliseconds) that objects in the cache are held in memory. Default is 30,000 milliseconds (30 seconds).

===Lighttpd, NginX and Cherokee performance===
You can increase server performance by using a '''light-weight''' webserver like [http://www.lighttpd.net/ lighttpd], [http://nginx.net/ nginx] or [http://www.cherokee-project.com/ cherokee] in combination with PHP in FastCGI-mode. Lighttpd was originally created as a proof-of-concept[http://www.lighttpd.net/story] to address the [http://www.kegel.com/c10k.html C10k problem] and while primarily recommended for memory-limited servers, its design origins and asynchronous-IO model make it a suitable and proven[http://blog.lighttpd.net/articles/2006/12/28/lighttpd-powers-5-alexa-top-250-sites] alternative HTTP server for high-load websites and web apps, including Moodle. See the [[lighttpd | MoodleDocs Lighttpd page]] for additional information, configuration example and links.

Alternatively, both [http://www.lighttpd.net/ lighttpd] and [http://nginx.net/ nginx] are capable of performing as a load-balancer and/or reverse-proxy to alleviate load on back-end servers[http://www.linuxjournal.com/article/10108], providing benefit without requiring an actual software change on existing servers.

Do note that these are likely to be the least tested server environments of all particularly if you are using advanced features such as web services and/or Moodle Networking. They are probably best considered for heavily used Moodle sites with relatively simple configurations.

===X-Sendfile===

X-Sendfile modules improve performance when sending large files from Moodle. It is recommended to configure your web server and Moodle to use this feature of available.

Configure web server:
* Apache - https://tn123.org/mod_xsendfile/
* Lighttpd - http://redmine.lighttpd.net/projects/lighttpd/wiki/X-LIGHTTPD-send-file
* Nginx - http://wiki.nginx.org/XSendfile

Enable support in config.php (see config-dist.php):
<code php>
// $CFG->xsendfile = 'X-Sendfile'; // Apache {@see https://tn123.org/mod_xsendfile/}
// $CFG->xsendfile = 'X-LIGHTTPD-send-file'; // Lighttpd {@see http://redmine.lighttpd.net/projects/lighttpd/wiki/X-LIGHTTPD-send-file}
// $CFG->xsendfile = 'X-Accel-Redirect'; // Nginx {@see http://wiki.nginx.org/XSendfile}
</code>

Configure file location prefixes if your server implementation requires it:
<code php>
// $CFG->xsendfilealiases = array(
// '/dataroot/' => $CFG->dataroot,
// '/cachedir/' => '/var/www/moodle/cache', // for custom $CFG->cachedir locations
// '/localcachedir/' => '/var/local/cache', // for custom $CFG->localcachedir locations
// '/tempdir/' => '/var/www/moodle/temp', // for custom $CFG->tempdir locations
// '/filedir' => '/var/www/moodle/filedir', // for custom $CFG->filedir locations
// );
</code>

==Database performance==

===MySQL performance===

The following are MySQL specific settings which can be adjusted for better performance in your my.cnf (my.ini in Windows). The file contains a list of settings and their values. To see the current values use these commands
SHOW STATUS;
SHOW VARIABLES;
'''Important''': You must make backups of your database before attempting to change any MySQL server configuration. After any change to the my.cnf, restart mysqld.

If you are able, the [http://mysqltuner.com/ MySQLTuner] tool can be run against your MySQL server and will calculate appropriate configuration values for most of the following settings based on your current load, status and variables automatically.

* Enable the '''query cache''' with
query_cache_type = 1.
For most Moodle installs, set the following:
query_cache_size = 36M
query_cache_min_res_unit = 2K.
The query cache will improve performance if you are doing few updates on the database.
* Set the '''table cache''' correctly. For Moodle 1.6 set
table_cache = 256 #(table_open_cache in MySQL > 5.1.2)
(min), and for Moodle 1.7 set
table_cache = 512 #(table_open_cache in MySQL > 5.1.2)
(min). The table cache is used by all threads (connections), so monitor the value of opened_tables to further adjust - if opened_tables > 3 * table_cache(table_open_cache in MySQL > 5.1.2) then increase table_cache upto your OS limit. Note also that the figure for table_cache will also change depending on the number of modules and plugins you have installed. Find the number for your server by executing the mysql statement below. Look at the number returned and set table_cache to this value.
mysql>SELECT COUNT(table_name) FROM information_schema.tables WHERE table_schema='yourmoodledbname';
* Set the '''thread cache''' correctly. Adjust the value so that your thread cache utilization is as close to 100% as possible by this formula:
thread cache utilization (%) = (threads_created / connections) * 100
* The '''key buffer''' can improve the access speed to Moodle's SELECT queries. The correct size depends on the size of the index files (.myi) and in Moodle 1.6 or later (without any additional modules and plugins), the recommendation for this value is key_buffer_size = 32M. Ideally you want the database to be reading once from the disk for every 100 requests so monitor that the value is suitable for your install by adjusting the value of key_buffer_size so that the following formulas are true:
key_read / key_read_requests < 0.01
key_write / key_write_requests <= 1.0
* Set the '''maximum number of connections''' so that your users will not see a "Too many connections" message. Be careful that this may have an impact on the total memory used. MySQL connections usually last for milliseconds, so it is unusual even for a heavily loaded server for this value to be over 200.
* Manage '''high burst activity'''. If your Moodle install uses a lot of quizzes and you are experiencing performance problems (check by monitoring the value of threads_connected - it should not be rising) consider increasing the value of back_log.
* '''Optimize your tables weekly and after upgrading Moodle'''. It is good practice to also optimize your tables after performing a large data deletion exercise, e.g. at the end of your semester or academic year. This will ensure that index files are up to date. Backup your database first and then use:
mysql>CHECK TABLE mdl_tablename;
mysql>OPTIMIZE TABLE mdl_tablename;
:The common tables in Moodle to check are mdl_course_sections, mdl_forum_posts, mdl_log and mdl_sessions (if using dbsessions). Any errors need to be corrected using REPAIR TABLE (see the [http://dev.mysql.com/doc/refman/5.0/en/repair-table.html MySQL manual] and this [http://moodle.org/mod/forum/discuss.php?d=58208#p279638 forum script]).
* '''Maintain the key distribution'''. Every month or so it is a good idea to stop the mysql server and run these myisamchk commands.
#myisamchk -a -S /pathtomysql/data/moodledir/*.MYI
:'''Warning''': You must stop the mysql database process (mysqld) before running any myisamchk command. If you do not, you risk data loss.
* Reduce the number of '''temporary tables saved to disk'''. Check this with the created_tmp_disk_tables value. If this is relatively large (>5%) increase tmp_table_size until you see a reduction. Note that this will have an impact on RAM usage.

===PostgreSQL performance===

There are some good papers around on tuning PostgreSQL (like [http://wiki.postgresql.org/wiki/Tuning_Your_PostgreSQL_Server this one]), and Moodle's case does not seem to be different to the general case.

The first thing to recognise is that if you really need to worry about tuning you should be using a separate machine for the database server. If you are not using a separate machine then the answers to many performance questions are substantially muddied by the memory requirements of the rest of the application.

You should probably '''enable autovacuum''', unless you know what you are doing. Many e-learning sites have predictable periods of low use, so disabling autovacuum and running a specific vacuum at those times can be a good option. Or perhaps leave autovacuum running but do a full vacuum weekly in a quiet period.

Set '''shared_buffers''' to something reasonable. For versions up to 8.1 my testing has shown that peak performance is almost always obtained with buffers < 10000, so if you are using such a version, and have more than 512M of RAM just set shared_buffers to 10,000 (8MB).

The buffer management had a big overhaul in 8.2 and "reasonable" is now a much larger number. I have not conducted performance tests with 8.2, but the recommendations from others are generally that you should now scale shared_buffers much more with memory and may continue to reap benefits even up to values like 100,000 (80MB). Consider using 1-2% of system RAM.

PostgreSQL will also assume that the operating system is caching its files, so setting '''effective_cache_size''' to a reasonable value is also a good idea. A reasonable value will usually be (total RAM - RAM in use by programs). If you are running Linux and leave the system running for a day or two you can look at 'free' and under the 'cached' column you will see what it currently is. Consider taking that number (which is kB) and dividing it by 10 (i.e. allow 20% for other programs cache needs and then divide by 8 to get pages). If you are not using a dedicated database server you will need to decrease that value to account for usage by other programs.

Some other useful parameters that can have positive effects, and the values I would typically set them to on a machine with 4G RAM, are:

work_mem = 10240

That's 10M of RAM to use instead of on-disk sorting and so forth. That can give a big speed increase, but it is per connection and 200 connections * 10M is 2G, so it can theoretically chew up a lot of RAM.

maintenance_work_mem = 163840

That's 160M of RAM which will be used by (e.g.) VACUUM, index rebuild, cluster and so forth. This should only be used periodically and should be freed when those processes exit, so I believe it is well worth while.

wal_buffers = 64

These buffers are used for the write-ahead log, and there have been a number of reports on the PostgreSQL mailing lists of improvement from this level of increase.

This is a little out of date now (version 8.0) but still worth a read: http://www.powerpostgresql.com/Docs

And there is lots of good stuff here as well: http://www.varlena.com/GeneralBits/Tidbits/index.php

''Based on Andrew McMillan's post at [http://moodle.org/mod/forum/discuss.php?d=68558 Tuning PostgreSQL] forum thread.''

* Splitting '''mdl_log''' to several tables and using a VIEW with UNION to read them as one. (See Tim Hunt [https://moodle.org/mod/forum/discuss.php?d=243531#p1104165 explanation] on the Moodle forums)

===Other database performance links===
* Consider using a '''distributed cacheing system''' like [http://en.wikipedia.org/wiki/Memcached memcached] but note that memcached does not have any security features so it should be used behind a firewall.
* Consider using PostgreSQL. See [[Arguments in favour of PostgreSQL]] and [http://moodle.org/mod/forum/discuss.php?d=49195 how to migrate from MySQL to PostgreSQL] (forum discussion).
* [http://dev.mysql.com/doc/refman/5.0/en/server-parameters.html General advice on tuning MySQL parameters] (advice from the MySQL manual)
* [http://www.mysqlperformanceblog.com/2007/11/01/innodb-performance-optimization-basics/ InnoDB performance optimization] taken from the [http://www.mysqlperformanceblog.com/ MySQL performance blog] site.

==Performance of different Moodle modules==

Moodle's activity modules, filters, and other plugins can be activated/deactivated. If necessary, you may wish to deactivate some features (such as chat) if not required - but this isn't necessary. Some notes on the performance of certain modules:

* The '''Chat''' module is [http://moodle.org/mod/forum/discuss.php?d=37979&parent=175079 said] to be a hog in terms of frequent HTTP requests to the main server. This can be reduced by setting the module to use ''Streamed'' updates, or, if you're using a Unix-based webserver, by running the chat in daemon mode. When using the Chat module use the configuration settings to tune for your expected load. Pay particular attention to the ''chat_old_ping'' and ''chat_refresh'' parameters as these can have greatest impact on server load.
* The Moodle '''Cron''' task is triggered by calling the script ''cron.php''. If this is called over HTTP (e.g. using wget or curl) it can take a large amount of memory on large installations. If it is called by directly invoking the php command (e.g. ''php -f /path/to/moodle/directory/admin/cli/cron.php'') efficiency can be much improved.
* The '''Recent activities''' block is consuming too many resources if you have huge number of records <code>mdl_log</code>. This is being tested to optimize the SQL query.
* The '''Quiz''' module is known to stretch database performance. However, it has been getting better in recent versions, and we don't know of any good, up-to-date performance measurements. (Here is a [http://moodle.org/mod/forum/discuss.php?d=68579 case study from 2007 with 300 quiz users].). The following suggestions were described by [https://moodle.org/user/view.php?id=94615&course=5 Al Rachels] in [https://moodle.org/mod/forum/discuss.php?d=347126 this forum thread]:
** make sure both Moodle, and the operating system, are installed on a [https://en.wikipedia.org/wiki/Solid-state_drive solid state drive]
** upgrade to and use [https://docs.moodle.org/dev/Moodle_and_PHP7 PHP 7]
** run MySQLTuner and implement its recommendations

See [[Performance settings]] for more information on performance-related Moodle settings.

==See also==

*Using Moodle: [http://moodle.org/mod/forum/view.php?f=94 Hardware and Performance] forum
*[http://opensourceelearning.blogspot.be/2012/10/why-your-moodle-site-is-slow-five.html Why Your Moodle Site is Slow: Five Simple Settings] blog post from Jonathan Moore
*I teach with Moodle perfomance testing: http://www.iteachwithmoodle.com/2012/11/17/moodle-2-4-beta-performance-test-comparison-with-moodle-2-3/
*[http://jfilip.ca/2013/08/20/moodle-2-4-5-vs-2-5-1-performance-and-muc-apc-cache-store/ Moodle 2.4.5 vs 2.5.2 performance and MUC APC cahe store]
*[http://jfilip.ca/2013/09/25/moodle-performance-testing-2-4-6-vs-2-5-2-vs-2-6dev/ Moodle performance testing 2.4.6 vs 2.5.2 vs 2.6dev]
*[http://jfilip.ca/2013/09/24/moodle-performance-analysis-revisted-now-with-mariadb/ Moodle performance analysis revisited (now with MariaDB)]
*[http://tjhunt.blogspot.ca/2013/05/performance-testing-moodle.html Tim Hunt's blog (May 2, 2013) on performance testing Moodle]
*[http://newrelic.com/ New Relic, Application Performance Monitoring]
*[http://blog.bitnami.com/2014/06/performance-enhacements-for-apache-and.html Performance enhacements for Apache and PHP (Apache Event MPM and PHP-FPM)]
*[https://scholarlms.net/performance-recommendations/ Performance recommendations]

There have been a lot of discussions on moodle.org about performance, here are some of the more interesting and (potentially) useful ones:

* [http://moodle.org/mod/forum/discuss.php?d=83057 Performance woes!]
* [http://moodle.org/mod/forum/discuss.php?d=57028 Performance perspectives - a little script]
* [http://moodle.org/mod/forum/discuss.php?d=88927 Comments on planned server hardware]
* [http://moodle.org/mod/forum/discuss.php?d=102978#p461624 Moodle performance in a pil by Martin Langhoff]
* [https://moodle.org/mod/forum/discuss.php?d=240391#unread Advice on optimising php/db code in moodle2+]
* [https://moodle.org/mod/forum/discuss.php?d=243531 Moodle 2.5 performance testing at the OU]
* [https://moodle.org/mod/forum/discuss.php?d=273602 100 active users limit with 4vCPU]
* [https://moodle.org/mod/forum/discuss.php?d=336603#p1356423 Performance Tip ... shared...]

[[es:Recomendaciones sobre desempeño]]
[[fr:Recommandations_de_performance]]
[[ja:パフォーマンス]]
[[de:Geschwindigkeitsempfehlungen]]

Standard Moodle tags

2019-09-20T17:22:39Z

Mina:

Tags are useful for connecting different bits of information together.

Obviously it's important to use the same tags everywhere.

This page describes standard Moodle tags that you should use when describing Moodle events on the internet (Flickr, Twitter, Facebook, del.icio.us etc)

==General Moodle stuff==

For general discussion of Moodle, use the tag "moodle".

Twitter example:
I just installed #moodle on a computer I bought ten years ago!

==Moodle Moots==

For Moodle conferences (Moots) use mootCCYY where:
* CC is a country ISO code or state abbreviation, and
* YY is a year.

mootAU09

Capitalisation doesn't matter and just helps readability.

The two letter code would usually be a country, but for somewhere like the US where there are different moots they might choose to use "us" or a state like "sf" or "ok". It really doesn't matter if two moots both used mootus09 for example, because they would be separated in time.

==Tags in use==

* #mooteu09 MoodleMoot Euskadi
* #mootNL09 Amsterdam Moodlemoot
* #mootUS09ok Moodlemoot Oklahoma (or #mootok09)
* #mootUS09SF Moodlemoot San Francisco (or #mootsf09)
* #mootin09 Goshen Midwest MoodleMoot
* #mootus09ny MoodleMoot Delhi (or #mootny09)
* #mootar09 MoodleMoot Argentina
* #mootat09 MoodleMoot Austria
* #mootDE09 MoodleMoot Germany 2009
* #mootco09 MoodleMoot Colombia
* #mootcl09 MoodleMoot Chile
* #mootes09 MoodleMoot Spain 2009
* #moodle #OE09 Moodle at Online Educa 2009 in Berlin (December)
* #moodledev09 [[Development:Czech Hackfest 2009|Czech Hackfest 2009]]
* #imoot and #imoot2010 iMoot 2010
* #mootJP10hk Moodlemoot Japan in Hakodate, February 2010
* #mootDE10b Moodlemoot Germany 2010 in Berlin March
* #mootDE10e [http://moodle2010.de/ Moodlemoot Germany 2010 in Essen] 16-17 September 2010
* #mootNZ10 Moodle Moot New Zealand (Christchurch) April 2010
* #mootUK10 MoodleMoot UK April 2010
* #mootsi10 Slovenian MoodleMoot
* #mootok10 MoodleMoot Oklahoma
* #mootau10 MoodleMoot AU 2010
* #mootcz10 [http://www.moodlemoot.cz/ MoodleMoot Czech Republic, Brno] 10-11 June 2010
* #mootfr10 6th French MoodleMoot
* #mootIT10 MoodleMoot Italia 2010
* #mootnl10 MoodleMoot NL 2010
* #mootPL10 Second Polish MoodleMoot, 4-5 November 2010, Czestochowa, Poland, http://moodlemoot.pl
* #mootusin10 Goshen, Indiana, USA 26-28 July, 2010
* #mootustx10 Austin, Texas, USA 2-3 August, 2010
* #mootfr11 [http://moodlemoot2011.uvt.rnu.tn/ 7th French MoodleMoot], Hammamet, Tunisia, 27-29 June 2011
* #mootde12 [http://moodlemoot.de/ German Moodlemoot], Münster, Germany, 13-16 March 2012
* #mootfr12 [http://moodlemoot2012.unimes.fr/ 8th French MoodleMoot], Nîmes, France, 20-22 June 2012
* #mootde13 [http://moodlemoot.de/ German Moodlemoot], München, Germany, 28 Feb - 1 Mar 2013
* #mootfr13 [http://moodlemoot2013.univ-bordeaux.fr/ 9th French MoodleMoot], Bordeaux, France, 5-7 June 2013
* #smootau13 [http://http://school.moodlemoot.com.au/ 2nd Australian Schoolmoot], Sydney, Australia, 2-4 October 2013
* #mootfr14 [http://moodlemoot2014.univ-paris3.fr 10th French MoodleMoot], Paris, 4-6 June 2014
* #mootfr15 [https://moodlemoot2015.univ-tours.fr 11th French MoodleMoot], Tours, 10-12 June 2015
* #mootfr16 [http://2016.moodlemoot.fr 12th French MoodleMoot], Sierre, Switzerland, 6-8 July 2016
* #mootfr17 [http://2017.moodlemoot.fr 13th French MoodleMoot], Lyon, 28-30 June 2017
* #mootfr18 [https://2018.moodlemoot.fr 14th French MoodleMoot], Bruxelles, 4-6 July 2018
* #mootfr19 [https://2019.moodlemoot.fr 15th French MoodleMoot], Rennes, 3-5 July 2019
* #mootBR19 [https://www.moodlebrasil.org 19th Brazil MoodleMoot], São Paulo, 25-26 April 2019

==See also==

* Lounge discussion [http://moodle.org/mod/forum/discuss.php?d=121619 A standard naming scheme for Moodle hashtags]

Parent role

2019-08-27T11:47:21Z

Mina:

{{Roles}}
The role of '''Parent''' may be used to provide parents/mentors/tutors with permission to view certain information, such as activity reports, grades, blog entries and forum posts, about their children/mentees/tutees.

The Parent role may also be allowed to agree to policies on behalf of their underage child. See the section on agreeing to policies on behalf of the child.

===Creating a new role===

#As an administrator, go to ''Site administration > Users > Permissions > Define roles'' and click the "Add a new role" button.
#For archetype role choose "No role."
#Give the role a short name (such as "Parent", but it can be anything appropriate, such as tutor/mentor)
#Give the role a custom full name (such as "Parent", but it can be anything appropriate, such as tutor/mentor)
#Under Context types where this role may be assigned check the '''user''' context.
#Under the heading of '''Course'''
#Change [[Capabilities/moodle/user:viewdetails|moodle/user:viewdetails]] to ''allow'' - to access the student's profile
#Under the heading of '''Users'''
#Change [[Capabilities/moodle/user:viewdetails|moodle/user:viewalldetails]] to ''allow'' - to view all aspects of the student's profile
#Change any/all of the following capabilities to ''allow''
#*[[Capabilities/moodle/user:readuserblogs|moodle/user:readuserblogs]] - to read the student's blog entries
#*[[Capabilities/moodle/user:readuserposts|moodle/user:readuserposts]] - to read the student's forum posts
#*[[Capabilities/moodle/user:viewuseractivitiesreport|moodle/user:viewuseractivitiesreport]] - to view the student's activity reports and grades
#*[[Capabilities/moodle/user:editprofile|moodle/user:editprofile]] - to edit the student's profile
#*[[Capabilities/tool/policy:acceptbehalf|tool/policy:acceptbehalf]] for accepting policies on behalf of the student.
#Click the "Create this role" button.

{|
| [[File:CustomRole05.png|thumb|Setting up the parent role]]
| [[File:CustomRole06.png|thumb|Assigning capabilities to the parent role]]
| [[File:CustomRole07.png|thumb|Saving changes to the parent role]]
|}

Some permissions may already be set to "Allow", or the permissions granted here may not be the ones required for that Role. This set of Permissions mean that this Role allows anyone assigned to a Parent Role, then linked to the Student Role, to edit the profile or read the blogs of that Student - not everyone's profile or blogs.

==Assigning the parent to the student==

*Access the child's full profile page, via '''Site administration ► Users ► Accounts ► Browse list of users'''
*Click the child's name to view the profile.
*In the Administration section, click Preferences
*In the Roles section, click Assign roles relative to this user
*Choose the role to assign i.e. Parent by clicking on the word.
*Select the parent in the potential users list and use the Add button to add it to the existing users list.

{|
| [[File:Parentroleassignroles.png|thumb|500px|"Assign roles relative to this user"]]
| [[File:choosingparent.png|thumb|500px|Assigning the parent to the student]]
|}

At this point you can return to the "Assign roles in user:" page and you should see that the parent name is now in the "Users with Role" column.

:'''NOTE:'''The same parent may be assigned to several students, siblings or otherwise.

===Agreeing to policies on behalf of the child===
If the parent has been given the [[Capabilities/tool/policy:acceptbehalf]] then they can click on the child's profile, click the Policies and agreements link and agree to the policies there:

[[File:ParentConsent.png|center|thumb|500px]]

===Adding the Mentees Block===
This block needs to be added so parents can see links to their child's profile.

* On the Front Page, turn editing on.
*Go to the '''Add Blocks''' block and select the [[Mentees block]] and when it appears, click on the Configuration icon.
*Edit the configuration settings to suit the needs of the site. When complete, save the changes and return to the Front Page.

{|
| [[File:addmenteesblock.png|thumb|Accessing the Add Blocks]]
| [[File:configuringmenteesblock.png|thumb|Setting the configuration values]]
|}

===How a parent sees their child's activities===

*Once the mentees block has been added, a parent/mentor sees the link to any children/mentees they are responsible for.
*They click on a name and will be taken to the profile page of that user.
*They then select from "Course profiles" - the name of a course the user is enrolled in.
*Grades may then be viewed by clicking in the Reports section
*Forum posts or similar may also be viewed from the user's profile in the Miscellaneous section.
{|
| [[File:MOParentRole01a.png|thumb|Click the name of a course in the profile]]
| [[File:MOParentRole02.png|thumb|Only '''then''' choose an item, for example grades]]
| [[File:MOParentRole03.png|thumb|The course grades are now visible]]
|}

*To view activity in another course, the parent needs to click back to the user's main profile and then select another course link.

==See also==
*[http://www.youtube.com/watch?v=Gk_TRi_N00o The Parent role in Moodle 2.0 video]
*[[Create_custom_roles|Create a custom role]]

[[eu:Guraso_rola]]
[[fr:Rôle parent]]
[[ja:親ロール]]
[[de:Eltern-Rolle]]
[[es:Rol paterno]]

MoodleBox

2019-08-21T06:22:53Z

Mina:

{{Infobox plugin
|type = Admin Tool
|entry = https://moodle.org/plugins/view.php?plugin=tool_moodlebox
|tracker = https://github.com/moodlebox/moodle-tool_moodlebox/issues
|discussion = https://discuss.moodlebox.net
|maintainer = [[User:Nicolas Martignoni|Nicolas Martignoni]]
|float = right
}}
{{Note|You can find the most up-to-date documentation for this plugin in the MoodleBox webpage at https://moodlebox.net. This page is intended for users that click on the 'Moodle Docs for this page' link.}}
The [https://moodle.org/plugins/view.php?plugin=tool_moodlebox MoodleBox plugin for Moodle] is an administration tool providing a GUI to some settings and management of a [https://moodlebox.net MoodleBox], a Moodle server installed on a [https://en.wikipedia.org/wiki/Raspberry_Pi Raspberry Pi].

It enables a Moodle administrator to monitor some hardware settings, to set the date of the [https://moodlebox.net MoodleBox], to allow restart and shutdown of the [https://moodlebox.net MoodleBox] and changing Raspberry Pi passwords using a GUI. After the installation in Moodle, some steps are required to complete on the Raspberry Pi (see below).

The plugin is compatible with Moodle 3.6 or later. A Raspberry Pi model 3A+, 3B, 3B+ or 4B is recommended.

== Requirements ==

* A [https://en.wikipedia.org/wiki/Raspberry_Pi Raspberry Pi] (Model 3A+, 3B, 3B+ or 4B recommended)
* [https://en.wikipedia.org/wiki/Raspbian Raspbian] installed (or another Linux based distribution)
* Package Incron installed
* Moodle installed (obviously)

== Installation==

The MoodleBox plugin must be installed in the Moodle tree of the [https://moodlebox.net MoodleBox], in the tool folder. Once installed, an new option MoodleBox will be available in Moodle, under ''Site administration > Server'' in the Administration block.

To complete the installation, you have to create some files in the plugin folder and configure some incron jobs on the MoodleBox.

=== Create necessary files ===

'''This step is not needed anymore for versions 1.10 or later'''

touch .reboot-server; touch .shutdown-server; touch .set-server-datetime; touch .newpassword; touch .wifisettings
chown -R www-data:www-data /var/www/moodle/admin/tool/moodlebox

=== Install incron package and allow root to run it ===
sudo apt-get install incron
echo root | sudo tee -a /etc/incron.allow

=== Add following lines to incrontab ===
/var/www/moodle/admin/tool/moodlebox/.reboot-server IN_CLOSE_WRITE /sbin/shutdown -r now
/var/www/moodle/admin/tool/moodlebox/.shutdown-server IN_CLOSE_WRITE /sbin/shutdown -h now
/var/www/moodle/admin/tool/moodlebox/.set-server-datetime IN_CLOSE_WRITE /bin/bash /var/www/moodle/admin/tool/moodlebox/.set-server-datetime
/var/www/moodle/admin/tool/moodlebox/.newpassword IN_CLOSE_WRITE /bin/bash /var/www/moodle/admin/tool/moodlebox/bin/changepassword.sh
/var/www/moodle/admin/tool/moodlebox/.wifisettings IN_CLOSE_WRITE /bin/bash /var/www/moodle/admin/tool/moodlebox/bin/changewifisettings.sh

=== Copy the following line at the end of file /etc/sudoers ===
www-data ALL=(ALL) NOPASSWD:/sbin/parted /dev/mmcblk0 unit MB print free

=== [[Secure Moodle on Raspberry Pi Model 2, Gentoo Linux and Nginx server|Secure your Moodlebox]] ===

This is not needed in normal MoodleBox use, i.e. if you don't expose your MoodleBox on the Internet.

== Features ==

* Info about the MoodleBox (kernel version, Raspbian version, free space on SD card, CPU load, CPU temperature, CPU frequency, uptime, DHCP clients).
* GUI to set the MoodleBox date and time.
* GUI to set the MoodleBox password.
* GUI to set the MoodleBox Wi-Fi network password, SSID and channel.
* GUI to restart and shutdown the MoodleBox.

== Availability ==

The code is available at [https://github.com/moodlebox/moodle-tool_moodlebox https://github.com/moodlebox/moodle-tool_moodlebox].

== See also ==

* [https://moodlebox.net MoodleBox documentation]

[[Category:Contributed code]]

[[es:MoodleBox]]

Användare:Nicolas Martignoni

2019-08-08T07:39:24Z

Mina: /* My activities around Moodle */

== My activities around Moodle ==

* In charge of the french translation of Moodle
* Management of the community ''[http://moodle.org/course/view.php?id=20 Moodle en français]'' on moodle.org
* Sysop of french [[:fr:Accueil|Moodle Docs]]
* Maintainer of MoodleBox project, a Moodle server on Raspberry: [https://moodlebox.net/ MoodleBox]
* My [http://moodle.org/user/view.php?id=6406&course=5 user profile] on moodle.org

=== Some useful pages ===

* [https://docs.moodle.org/400/sv/index.php?title=Special%3AAllPages&namespace=10 Templates]
* [[Special:Categories|Categories]]

[[fr:User:Nicolas Martignoni]]

MoodleBox

2019-07-23T18:29:57Z

Mina: Change links

{{Infobox plugin
|type = Admin Tool
|entry = https://moodle.org/plugins/view.php?plugin=tool_moodlebox
|tracker = https://github.com/moodlebox/moodle-tool_moodlebox/issues
|discussion = https://discuss.moodlebox.net
|maintainer = [[User:Nicolas Martignoni|Nicolas Martignoni]]
|float = right
}}
The [https://moodle.org/plugins/view.php?plugin=tool_moodlebox MoodleBox plugin for Moodle] is an administration tool providing a GUI to some settings and management of a [https://moodlebox.net MoodleBox], a Moodle server installed on a [https://en.wikipedia.org/wiki/Raspberry_Pi Raspberry Pi].

It enables a Moodle administrator to monitor some hardware settings, to set the date of the [https://moodlebox.net MoodleBox], to allow restart and shutdown of the [https://moodlebox.net MoodleBox] and changing Raspberry Pi passwords using a GUI. After the installation in Moodle, some steps are required to complete on the Raspberry Pi (see below).

The plugin is compatible with Moodle 3.6 or later. A Raspberry Pi model 3A+, 3B, 3B+ or 4B is recommended.

== Requirements ==

* A [https://en.wikipedia.org/wiki/Raspberry_Pi Raspberry Pi] (Model 3A+, 3B, 3B+ or 4B recommended)
* [https://en.wikipedia.org/wiki/Raspbian Raspbian] installed (or another Linux based distribution)
* Package Incron installed
* Moodle installed (obviously)

== Installation==

The MoodleBox plugin must be installed in the Moodle tree of the [https://moodlebox.net MoodleBox], in the tool folder. Once installed, an new option MoodleBox will be available in Moodle, under ''Site administration > Server'' in the Administration block.

To complete the installation, you have to create some files in the plugin folder and configure some incron jobs on the MoodleBox.

=== Create necessary files ===

'''This step is not needed anymore for versions 1.10 or later'''

touch .reboot-server; touch .shutdown-server; touch .set-server-datetime; touch .newpassword; touch .wifisettings
chown -R www-data:www-data /var/www/moodle/admin/tool/moodlebox

=== Install incron package and allow root to run it ===
sudo apt-get install incron
echo root | sudo tee -a /etc/incron.allow

=== Add following lines to incrontab ===
/var/www/moodle/admin/tool/moodlebox/.reboot-server IN_CLOSE_WRITE /sbin/shutdown -r now
/var/www/moodle/admin/tool/moodlebox/.shutdown-server IN_CLOSE_WRITE /sbin/shutdown -h now
/var/www/moodle/admin/tool/moodlebox/.set-server-datetime IN_CLOSE_WRITE /bin/bash /var/www/moodle/admin/tool/moodlebox/.set-server-datetime
/var/www/moodle/admin/tool/moodlebox/.newpassword IN_CLOSE_WRITE /bin/bash /var/www/moodle/admin/tool/moodlebox/bin/changepassword.sh
/var/www/moodle/admin/tool/moodlebox/.wifisettings IN_CLOSE_WRITE /bin/bash /var/www/moodle/admin/tool/moodlebox/bin/changewifisettings.sh

=== Copy the following line at the end of file /etc/sudoers ===
www-data ALL=(ALL) NOPASSWD:/sbin/parted /dev/mmcblk0 unit MB print free

=== [[Secure Moodle on Raspberry Pi Model 2, Gentoo Linux and Nginx server|Secure your Moodlebox]] ===

This is not needed in normal MoodleBox use, i.e. if you don't expose your MoodleBox on the Internet.

== Features ==

* Info about the MoodleBox (kernel version, Raspbian version, free space on SD card, CPU load, CPU temperature, CPU frequency, uptime, DHCP clients).
* GUI to set the MoodleBox date and time.
* GUI to set the MoodleBox password.
* GUI to set the MoodleBox Wi-Fi network password, SSID and channel.
* GUI to restart and shutdown the MoodleBox.

== Availability ==

The code is available at [https://github.com/moodlebox/moodle-tool_moodlebox https://github.com/moodlebox/moodle-tool_moodlebox].

== See also ==

* [https://moodlebox.net MoodleBox documentation]

[[Category:Contributed code]]

[[es:MoodleBox]]

MoodleBox

2019-07-23T13:09:04Z

Mina: /* Secure your Moodlebox */

{{Infobox plugin
|type = Admin Tool
|entry = https://moodle.org/plugins/view.php?plugin=tool_moodlebox
|tracker = https://tracker.moodle.org/browse/CONTRIB-6757
|discussion = N/A
|maintainer = [[User:Nicolas Martignoni|Nicolas Martignoni]]
|float = right
}}
The [https://moodle.org/plugins/view.php?plugin=tool_moodlebox MoodleBox plugin for Moodle] is an administration tool providing a GUI to some settings and management of a [https://moodlebox.net MoodleBox], a Moodle server installed on a [https://en.wikipedia.org/wiki/Raspberry_Pi Raspberry Pi].

It enables a Moodle administrator to monitor some hardware settings, to set the date of the [https://moodlebox.net MoodleBox], to allow restart and shutdown of the [https://moodlebox.net MoodleBox] and changing Raspberry Pi passwords using a GUI. After the installation in Moodle, some steps are required to complete on the Raspberry Pi (see below).

The plugin is compatible with Moodle 3.6 or later. A Raspberry Pi model 3A+, 3B, 3B+ or 4B is recommended.

== Requirements ==

* A [https://en.wikipedia.org/wiki/Raspberry_Pi Raspberry Pi] (Model 3A+, 3B, 3B+ or 4B recommended)
* [https://en.wikipedia.org/wiki/Raspbian Raspbian] installed (or another Linux based distribution)
* Package Incron installed
* Moodle installed (obviously)

== Installation==

The MoodleBox plugin must be installed in the Moodle tree of the [https://moodlebox.net MoodleBox], in the tool folder. Once installed, an new option MoodleBox will be available in Moodle, under ''Site administration > Server'' in the Administration block.

To complete the installation, you have to create some files in the plugin folder and configure some incron jobs on the MoodleBox.

=== Create necessary files ===

'''This step is not needed anymore for versions 1.10 or later'''

touch .reboot-server; touch .shutdown-server; touch .set-server-datetime; touch .newpassword; touch .wifisettings
chown -R www-data:www-data /var/www/moodle/admin/tool/moodlebox

=== Install incron package and allow root to run it ===
sudo apt-get install incron
echo root | sudo tee -a /etc/incron.allow

=== Add following lines to incrontab ===
/var/www/moodle/admin/tool/moodlebox/.reboot-server IN_CLOSE_WRITE /sbin/shutdown -r now
/var/www/moodle/admin/tool/moodlebox/.shutdown-server IN_CLOSE_WRITE /sbin/shutdown -h now
/var/www/moodle/admin/tool/moodlebox/.set-server-datetime IN_CLOSE_WRITE /bin/bash /var/www/moodle/admin/tool/moodlebox/.set-server-datetime
/var/www/moodle/admin/tool/moodlebox/.newpassword IN_CLOSE_WRITE /bin/bash /var/www/moodle/admin/tool/moodlebox/bin/changepassword.sh
/var/www/moodle/admin/tool/moodlebox/.wifisettings IN_CLOSE_WRITE /bin/bash /var/www/moodle/admin/tool/moodlebox/bin/changewifisettings.sh

=== Copy the following line at the end of file /etc/sudoers ===
www-data ALL=(ALL) NOPASSWD:/sbin/parted /dev/mmcblk0 unit MB print free

=== [[Secure Moodle on Raspberry Pi Model 2, Gentoo Linux and Nginx server|Secure your Moodlebox]] ===

This is not needed in normal MoodleBox use, i.e. if you don't expose your MoodleBox on the Internet.

== Features ==

* Info about the MoodleBox (kernel version, Raspbian version, free space on SD card, CPU load, CPU temperature, CPU frequency, uptime, DHCP clients).
* GUI to set the MoodleBox date and time.
* GUI to set the MoodleBox password.
* GUI to set the MoodleBox Wi-Fi network password, SSID and channel.
* GUI to restart and shutdown the MoodleBox.

== Availability ==

The code is available at [https://github.com/moodlebox/moodle-tool_moodlebox https://github.com/moodlebox/moodle-tool_moodlebox].

== See also ==

* [https://moodlebox.net MoodleBox documentation]

[[Category:Contributed code]]

[[es:MoodleBox]]

MoodleBox

2019-07-23T13:06:11Z

Mina: /* Requirements */

{{Infobox plugin
|type = Admin Tool
|entry = https://moodle.org/plugins/view.php?plugin=tool_moodlebox
|tracker = https://tracker.moodle.org/browse/CONTRIB-6757
|discussion = N/A
|maintainer = [[User:Nicolas Martignoni|Nicolas Martignoni]]
|float = right
}}
The [https://moodle.org/plugins/view.php?plugin=tool_moodlebox MoodleBox plugin for Moodle] is an administration tool providing a GUI to some settings and management of a [https://moodlebox.net MoodleBox], a Moodle server installed on a [https://en.wikipedia.org/wiki/Raspberry_Pi Raspberry Pi].

It enables a Moodle administrator to monitor some hardware settings, to set the date of the [https://moodlebox.net MoodleBox], to allow restart and shutdown of the [https://moodlebox.net MoodleBox] and changing Raspberry Pi passwords using a GUI. After the installation in Moodle, some steps are required to complete on the Raspberry Pi (see below).

The plugin is compatible with Moodle 3.6 or later. A Raspberry Pi model 3A+, 3B, 3B+ or 4B is recommended.

== Requirements ==

* A [https://en.wikipedia.org/wiki/Raspberry_Pi Raspberry Pi] (Model 3A+, 3B, 3B+ or 4B recommended)
* [https://en.wikipedia.org/wiki/Raspbian Raspbian] installed (or another Linux based distribution)
* Package Incron installed
* Moodle installed (obviously)

== Installation==

The MoodleBox plugin must be installed in the Moodle tree of the [https://moodlebox.net MoodleBox], in the tool folder. Once installed, an new option MoodleBox will be available in Moodle, under ''Site administration > Server'' in the Administration block.

To complete the installation, you have to create some files in the plugin folder and configure some incron jobs on the MoodleBox.

=== Create necessary files ===

'''This step is not needed anymore for versions 1.10 or later'''

touch .reboot-server; touch .shutdown-server; touch .set-server-datetime; touch .newpassword; touch .wifisettings
chown -R www-data:www-data /var/www/moodle/admin/tool/moodlebox

=== Install incron package and allow root to run it ===
sudo apt-get install incron
echo root | sudo tee -a /etc/incron.allow

=== Add following lines to incrontab ===
/var/www/moodle/admin/tool/moodlebox/.reboot-server IN_CLOSE_WRITE /sbin/shutdown -r now
/var/www/moodle/admin/tool/moodlebox/.shutdown-server IN_CLOSE_WRITE /sbin/shutdown -h now
/var/www/moodle/admin/tool/moodlebox/.set-server-datetime IN_CLOSE_WRITE /bin/bash /var/www/moodle/admin/tool/moodlebox/.set-server-datetime
/var/www/moodle/admin/tool/moodlebox/.newpassword IN_CLOSE_WRITE /bin/bash /var/www/moodle/admin/tool/moodlebox/bin/changepassword.sh
/var/www/moodle/admin/tool/moodlebox/.wifisettings IN_CLOSE_WRITE /bin/bash /var/www/moodle/admin/tool/moodlebox/bin/changewifisettings.sh

=== Copy the following line at the end of file /etc/sudoers ===
www-data ALL=(ALL) NOPASSWD:/sbin/parted /dev/mmcblk0 unit MB print free

=== [[Secure Moodle on Raspberry Pi Model 2, Gentoo Linux and Nginx server|Secure your Moodlebox]] ===

== Features ==

* Info about the MoodleBox (kernel version, Raspbian version, free space on SD card, CPU load, CPU temperature, CPU frequency, uptime, DHCP clients).
* GUI to set the MoodleBox date and time.
* GUI to set the MoodleBox password.
* GUI to set the MoodleBox Wi-Fi network password, SSID and channel.
* GUI to restart and shutdown the MoodleBox.

== Availability ==

The code is available at [https://github.com/moodlebox/moodle-tool_moodlebox https://github.com/moodlebox/moodle-tool_moodlebox].

== See also ==

* [https://moodlebox.net MoodleBox documentation]

[[Category:Contributed code]]

[[es:MoodleBox]]

MoodleBox

2019-07-23T13:05:50Z

Mina:

{{Infobox plugin
|type = Admin Tool
|entry = https://moodle.org/plugins/view.php?plugin=tool_moodlebox
|tracker = https://tracker.moodle.org/browse/CONTRIB-6757
|discussion = N/A
|maintainer = [[User:Nicolas Martignoni|Nicolas Martignoni]]
|float = right
}}
The [https://moodle.org/plugins/view.php?plugin=tool_moodlebox MoodleBox plugin for Moodle] is an administration tool providing a GUI to some settings and management of a [https://moodlebox.net MoodleBox], a Moodle server installed on a [https://en.wikipedia.org/wiki/Raspberry_Pi Raspberry Pi].

It enables a Moodle administrator to monitor some hardware settings, to set the date of the [https://moodlebox.net MoodleBox], to allow restart and shutdown of the [https://moodlebox.net MoodleBox] and changing Raspberry Pi passwords using a GUI. After the installation in Moodle, some steps are required to complete on the Raspberry Pi (see below).

The plugin is compatible with Moodle 3.6 or later. A Raspberry Pi model 3A+, 3B, 3B+ or 4B is recommended.

== Requirements ==

* A [https://en.wikipedia.org/wiki/Raspberry_Pi Raspberry Pi] (Model 3B or 3B+ recommended)
* [https://en.wikipedia.org/wiki/Raspbian Raspbian] installed (or another Linux based distribution)
* Package Incron installed
* Moodle installed (obviously)

== Installation==

The MoodleBox plugin must be installed in the Moodle tree of the [https://moodlebox.net MoodleBox], in the tool folder. Once installed, an new option MoodleBox will be available in Moodle, under ''Site administration > Server'' in the Administration block.

To complete the installation, you have to create some files in the plugin folder and configure some incron jobs on the MoodleBox.

=== Create necessary files ===

'''This step is not needed anymore for versions 1.10 or later'''

touch .reboot-server; touch .shutdown-server; touch .set-server-datetime; touch .newpassword; touch .wifisettings
chown -R www-data:www-data /var/www/moodle/admin/tool/moodlebox

=== Install incron package and allow root to run it ===
sudo apt-get install incron
echo root | sudo tee -a /etc/incron.allow

=== Add following lines to incrontab ===
/var/www/moodle/admin/tool/moodlebox/.reboot-server IN_CLOSE_WRITE /sbin/shutdown -r now
/var/www/moodle/admin/tool/moodlebox/.shutdown-server IN_CLOSE_WRITE /sbin/shutdown -h now
/var/www/moodle/admin/tool/moodlebox/.set-server-datetime IN_CLOSE_WRITE /bin/bash /var/www/moodle/admin/tool/moodlebox/.set-server-datetime
/var/www/moodle/admin/tool/moodlebox/.newpassword IN_CLOSE_WRITE /bin/bash /var/www/moodle/admin/tool/moodlebox/bin/changepassword.sh
/var/www/moodle/admin/tool/moodlebox/.wifisettings IN_CLOSE_WRITE /bin/bash /var/www/moodle/admin/tool/moodlebox/bin/changewifisettings.sh

=== Copy the following line at the end of file /etc/sudoers ===
www-data ALL=(ALL) NOPASSWD:/sbin/parted /dev/mmcblk0 unit MB print free

=== [[Secure Moodle on Raspberry Pi Model 2, Gentoo Linux and Nginx server|Secure your Moodlebox]] ===

== Features ==

* Info about the MoodleBox (kernel version, Raspbian version, free space on SD card, CPU load, CPU temperature, CPU frequency, uptime, DHCP clients).
* GUI to set the MoodleBox date and time.
* GUI to set the MoodleBox password.
* GUI to set the MoodleBox Wi-Fi network password, SSID and channel.
* GUI to restart and shutdown the MoodleBox.

== Availability ==

The code is available at [https://github.com/moodlebox/moodle-tool_moodlebox https://github.com/moodlebox/moodle-tool_moodlebox].

== See also ==

* [https://moodlebox.net MoodleBox documentation]

[[Category:Contributed code]]

[[es:MoodleBox]]

Diskussion:MoodleBox

2019-07-23T13:04:19Z

Mina:

Maybe "A Raspberry Pi model 3B or 3B+ is recommended" should be updated to include Raspberry Pi 4 (4 GB or 2 GB).[[User:German Valero|German Valero]] ([[User talk:German Valero|talk]])

Thanks, done
-- [[User:Nicolas Martignoni|Nicolas Martignoni]] ([[User talk:Nicolas Martignoni|talk]]) 13:04, 23 July 2019 (UTC)

MoodleBox

2019-07-23T13:02:47Z

Mina: Update RPi models

{{Infobox plugin
|type = Admin Tool
|entry = https://moodle.org/plugins/view.php?plugin=tool_moodlebox
|tracker = https://tracker.moodle.org/browse/CONTRIB-6757
|discussion = N/A
|maintainer = [[User:Nicolas Martignoni|Nicolas Martignoni]]
|float = right
}}
The [https://moodle.org/plugins/view.php?plugin=tool_moodlebox MoodleBox plugin for Moodle] is an administration tool providing a GUI to some settings and management of a [https://moodlebox.net MoodleBox], a Moodle server installed on a [https://en.wikipedia.org/wiki/Raspberry_Pi Raspberry Pi].

It enables a Moodle administrator to monitor some hardware settings, to set the date of the [https://moodlebox.net MoodleBox], to allow restart and shutdown of the [https://moodlebox.net MoodleBox] and changing Raspberry Pi passwords using a GUI. After the installation in Moodle, some steps are required to complete on the Raspberry Pi (see below).

The plugin is compatible with Moodle 3.1 or later. A Raspberry Pi model 3A+, 3B, 3B+ or 4B is recommended.

== Requirements ==

* A [https://en.wikipedia.org/wiki/Raspberry_Pi Raspberry Pi] (Model 3B or 3B+ recommended)
* [https://en.wikipedia.org/wiki/Raspbian Raspbian] installed (or another Linux based distribution)
* Package Incron installed
* Moodle installed (obviously)

== Installation==

The MoodleBox plugin must be installed in the Moodle tree of the [https://moodlebox.net MoodleBox], in the tool folder. Once installed, an new option MoodleBox will be available in Moodle, under ''Site administration > Server'' in the Administration block.

To complete the installation, you have to create some files in the plugin folder and configure some incron jobs on the MoodleBox.

=== Create necessary files ===

'''This step is not needed anymore for versions 1.10 or later'''

touch .reboot-server; touch .shutdown-server; touch .set-server-datetime; touch .newpassword; touch .wifisettings
chown -R www-data:www-data /var/www/moodle/admin/tool/moodlebox

=== Install incron package and allow root to run it ===
sudo apt-get install incron
echo root | sudo tee -a /etc/incron.allow

=== Add following lines to incrontab ===
/var/www/moodle/admin/tool/moodlebox/.reboot-server IN_CLOSE_WRITE /sbin/shutdown -r now
/var/www/moodle/admin/tool/moodlebox/.shutdown-server IN_CLOSE_WRITE /sbin/shutdown -h now
/var/www/moodle/admin/tool/moodlebox/.set-server-datetime IN_CLOSE_WRITE /bin/bash /var/www/moodle/admin/tool/moodlebox/.set-server-datetime
/var/www/moodle/admin/tool/moodlebox/.newpassword IN_CLOSE_WRITE /bin/bash /var/www/moodle/admin/tool/moodlebox/bin/changepassword.sh
/var/www/moodle/admin/tool/moodlebox/.wifisettings IN_CLOSE_WRITE /bin/bash /var/www/moodle/admin/tool/moodlebox/bin/changewifisettings.sh

=== Copy the following line at the end of file /etc/sudoers ===
www-data ALL=(ALL) NOPASSWD:/sbin/parted /dev/mmcblk0 unit MB print free

=== [[Secure Moodle on Raspberry Pi Model 2, Gentoo Linux and Nginx server|Secure your Moodlebox]] ===

== Features ==

* Info about the MoodleBox (kernel version, Raspbian version, free space on SD card, CPU load, CPU temperature, CPU frequency, uptime, DHCP clients).
* GUI to set the MoodleBox date and time.
* GUI to set the MoodleBox password.
* GUI to set the MoodleBox Wi-Fi network password, SSID and channel.
* GUI to restart and shutdown the MoodleBox.

== Availability ==

The code is available at [https://github.com/moodlebox/moodle-tool_moodlebox https://github.com/moodlebox/moodle-tool_moodlebox].

== See also ==

* [https://moodlebox.net MoodleBox documentation]

[[Category:Contributed code]]

[[es:MoodleBox]]

Användare:Nicolas Martignoni

2018-12-26T10:58:54Z

Mina: /* Some useful pages */

== My activities around Moodle ==

* In charge of the french translation of Moodle
* Management of the community ''[http://moodle.org/course/view.php?id=20 Moodle en français]'' on moodle.org
* Sysop of french [[:fr:Accueil|Moodle Docs]]
* Moodle on Raspberry project: [https://moodlebox.net/ MoodleBox]
* My [http://moodle.org/user/view.php?id=6406&course=5 user profile] on moodle.org

=== Some useful pages ===

* [https://docs.moodle.org/400/sv/index.php?title=Special%3AAllPages&namespace=10 Templates]
* [[Special:Categories|Categories]]

[[fr:User:Nicolas Martignoni]]

File system repository

2018-09-30T09:01:12Z

Mina: Link added.

{{Repositories}}
The file system repository allows access to files which have been uploaded (e.g. via FTP) into designated folders on the server. ''(Note that these folders are '''not''' created inside the Moodle site, but on the server where Moodle is hosted.)''

A file system repository may be available site wide for everyone or within an individual course (set up by admin) or for an individual administrator. See MDL-28656 regarding course and individual repository configuration.

This must be done by a systems admin who has write permissions to the server directories.

When a file from the file system repository is re-used elsewhere on Moodle, the teacher has the option to make a copy (a new, unconnected version) or to create a shortcut or alias. See [[Working with files]] for more details.

Once a repository has been created and files uploaded to it, the files can be made available within the file picker for use within a course. There are several steps to take to implement this feature:-

These must be done by a systems admin who has write permissions to the server directories and admin permissions within Moodle.

==Creating folders for your file system repositories==
*Find the moodledata folder on the server
*Inside it, create a folder called "repository"
*Inside that folder, create as many folders as you need, named appropriately.

{|
| [[File:filesystemonserver.png|thumb|250px|Creating repositories on the server]]
|}

*Copy into the appropriate folder the files you want (using FTP, SFTP, shared folder etc.). (The folders can hold all types of files)

== Enabling the File System repository plugin==
*Go to ''Administration > Site administration > Plugins > Repositories > Manage Repositories'';
*Select from the drop down next to File system "Enabled and visible"
''Note'': Ignore the similarly named repository 'Server Files' (enabled by default).
*Click the '''Settings''' link..

==Setting up a site-wide file system repository==
Having clicked the "Settings" link as above:
*Scroll down to Repositories instances of the site
*Click ''Create a repository instance''
*Give it a name and (if there are several folders on the server) choose from the dropdown the one you want. Click '''Save.'''
*It will now be available in the file picker in all courses.

{|
| [[File:createinstance23.png|thumb|Creating a new file system repository]]
| [[File:setuprepo23.png|thumb|Selecting and naming the repository]]
|}

''NOTE: Just repeat the process to get more than one site wide file system repository''

==Setting up a repository inside a course==
''NOTE only Moodle admins can do this''

Enable repositories as in the instructions above. On the Settings page:
*Check the top box allowing users to add a repository instance to the course (1 below)
*Go to the desired course and click on “repositories” in the administration block(2 below)
*Scroll down and click "Create File System instance" (3 below)

{|
| [[File:courseinstancerepo.png|thumb|1:Enable course repositories]]
| [[File:coursesettingsrepo1.png|thumb|2:Click "Repositories" in Course admin]]
| [[File:createcourseinstance.png|thumb|3:Click to create an instance in the course]]
|}

*Follow the same process as [[#Setting_up_a_site-wide_file_system_repository|here]]

==Setting up an individual file system repository instance==
''NOTE: Only Moodle admins can do this''

Enable repositories as in the instructions above. On the Settings page:
*Check the top box allowing users to add a repository instance to the user context (1 below)
*From the user menu, click "Preferences"
*Click on “Repositories”
*Click “Create File System instance”
*Follow the same process as [[#Setting_up_a_site-wide_file_system_repository|here]]
*This will create a personal file system repository connecting just you to a folder on the server (2 below)

{|
| [[File:userinstancerepo.png|thumb|1:Enable user repository instances]]
| [[File:userprivaterepo.png|thumb|2:Adding files from individual repository]]
|}

*Upload any files required by course creators to the appropriate folders

Server permissions are needed here to add via FTP (or other method) the required files.

From this point on the check boxes need not be set - leaving them set just invites people to create a repository instance and then advises them that they do not have sufficient privilges.

===Using a File System repository file===

A user can now make use of the uploaded files by accessing the repository from within the file picker, creating a resource link to a document, for example. This process copies the uploaded file into Moodle and students may access the resource.

It's possible to search the files in the File system repository to make locating files easier if there are many files available.

[[File:FileSystemreposearch.png|thumb|600px|center|Searching the file system repository]]

Note that file types are respected (based on file extensions), so if you are adding an image in the editor, then you won't see Office docs (for example) appear in the File Picker.

==Repository capabilities==

There is just one capability, [[Capabilities/repository/filesystem:view|View file system repository]], which is allowed for the default manager, course creator, non-editing teacher and editing teacher roles. It is not set for the authenticated user role. Thus, students cannot by default view the file system repository.

==See also==
*[[File_system_repository_FAQ|File system repository FAQ]]
* [[Restoring file aliases]]
* Overview of [[Repositories|Repositories]]
* [http://www.somerandomthoughts.com/blog/2010/06/15/ftp-files-into-moodle-2-0-with-the-repository-api/ FTP files into Moodle 2.0 with the repository API article from somerandomthoughts.com] including screencast

[[Category:Site administration]]
[[de:Dateisystem-Repository]]
[[es:Repositorio_sistema_de_archivo]]
[[fr:Dépôt système de fichier]]

Course restore

2018-09-04T12:31:00Z

Mina: Link updated

{{Backup}}
==Restoring a course backup==

A course backup file (.mbz) may be restored from within any existing course for which you have permission. During the restore process, you will be given the option to restore as a new course or into an existing course.

{{MediaPlayer | url = https://youtu.be/7ZMvdf9mwcQ | desc = Overview of course restore. (Instructions are for MoodleCloud but also apply to other sites.)}}

# With the [[Boost theme]] click the gear menu and then 'Restore' Otherwise, go to ''Site administration > Front page settings > Restore'' (if you have front page permissions) or ''Administration > Course administration > Restore'' (if you have an empty course to restore into.)
# Upload the backup file or choose a file in the course backup area or user private backup area and click Restore
# Confirm - Check that everything is as required then click the Continue button
# Destination - Choose whether the course should be restored as a new course or into an existing course then click the Continue button
# Settings - Select activities, blocks, filters and possibly other items as required then click the Next button
# Schema - Select/deselect specific items and amend the course name, short name and start date if necessary then click the Next button
# Review - Check that everything is as required, using the Previous button if necessary, then click the 'Perform restore' button
# Complete - Click the continue button

Notes:

# '''New in 3.4:''' If you are restoring a course with user data (forum posts for example) then the user data will keep the original dates, whereas the activities and sections will change according to the new course start time you set.
# If your new course has fewer sections than the course you are restoring, the extra sections will appear as "orphaned activities". Increase the number of sections in the new course to make them visible.
# If you are restoring a course from a different Moodle site and you obtain the error message "Trying to restore user (admin) from backup file will cause conflict", you can enable the setting 'Allow admin conflict resolution' in ''Site admin > Courses > Backups > General import defaults''
# In Moodle 3.3.2 onwards, when restoring a course containing calendar events from activities e.g. assignment due dates, these events will appear in the calendar a short while after restoring the course. The events are added to the calendar via a cron task. Restoring multiple courses will result in queued tasks with a possible delay before events appear in the calendar. (See MDL-58906 for further details.)

==Restoring from course and category management screens==

Users with permission to access ''Site administration > Courses > Manage courses and categories'' or ''Site administration > Courses > Manage courses and categories > (Category name)'' can restore courses from here:

{|
| [[File:RestoreBoost.png|thumb|300px|Boost theme]]
| [[File:courserestorecategory.png|thumb|300px|Non-Boost themes]]
|}

==General restore defaults==

An administrator can set defaults and lock selected restore settings in 'General restore defaults' in the Site administration. If a setting is locked, then it can not be changed when restoring a course.

Different defaults may be set for restoring and merging into another course and for restoring and deleting the course contents.

==Course restore capabilities==

* [[Capabilities/moodle/restore:createuser|Create users on restore]]
* [[Capabilities/moodle/restore:configure|Configure restore options]]
* [[Capabilities/moodle/restore:restoreactivity|Restore activities]]
* [[Capabilities/moodle/restore:restorecourse|Restore courses]]
* [[Capabilities/moodle/restore:restoresection|Restore sections]]
* [[Capabilities/moodle/restore:restoretargethub|Restore from files targeted as hub]]
* [[Capabilities/moodle/restore:restoretargetimport|Restore from files targeted as import]]
* [[Capabilities/moodle/restore:rolldates|Roll activity configuration dates on restore]]
* [[Capabilities/moodle/restore:uploadfile|Upload files to backup areas]]
* [[Capabilities/moodle/restore:userinfo|Restore user data]]
* [[Capabilities/moodle/restore:viewautomatedfilearea|Restore courses from automated backups]]

==See also==

* [[Restoring file aliases]]
* Administrators can use [http://moosh-online.com/commands/#course-restore MOOSH] to bulk backup and restore courses from CLI

[[fr:Restauration de cours]]
[[ja:リストア]]
[[es:Restaurar_un_curso]]
[[de:Kurswiederherstellung]]

Privacy officer role

2018-08-27T11:37:22Z

Mina: French translation link added.

{{Privacy}}
A Privacy officer can respond to data requests and manage the data registry.

==Role set-up==

# Go to 'Define roles' in the Site administration.
# Click the button "Add a new role".
# Leave 'Use role or archetype' set to 'No role' and click the continue button.
# Give the role a name such as 'Privacy officer', short name and description.
# For context types where this role may be assigned, tick system.
# Enter dataprivacy in the filter box, then allow the capabilities [[Capabilities/tool/dataprivacy:managedataregistry|tool/dataprivacy:managedataregistry]] and [[Capabilities/tool/dataprivacy:managedatarequests|tool/dataprivacy:managedatarequests]], and if necessary [[Capabilities/tool/dataprivacy:makedatarequestsforchildren|tool/dataprivacy:makedatarequestsforchildren]].
# Allow more capabilities as follows: [[Capabilities/moodle/site:configview|moodle/site:configview]], [[Capabilities/moodle/category:viewhiddencategories|moodle/category:viewhiddencategories]], [[Capabilities/moodle/course:viewhiddencourses|moodle/course:viewhiddencourses]], [[Capabilities/moodle/course:viewhiddenactivities|moodle/course:viewhiddenactivities]], [[Capabilities/moodle/course:view|moodle/course:view]].
# Optionally, add capabilities to allow Privacy officers to view and agree to policies on behalf of minors (after receiving permission from guardians): [[Capabilities/tool/policy:acceptbehalf|tool/policy:acceptbehalf]] and [[Capabilities/tool/policy:viewacceptances|tool/policy:viewacceptances]]
# Click the button "Create this role".

Next

# Go to 'Privacy settings' in the Site administration.
# Click to select the Privacy officer in the Privacy officer role mapping setting.
# Save changes.

==Role assignment==

# Go to 'Assign system roles' in the Site administration.
# Choose the Privacy officer role to assign.
# Select the user in the Potential users list, and use the left-facing arrow button to add them to the Existing users list.

[[Category: Privacy]]
[[Category:Roles]]

[[fr:Délégué à la Protection des Données]]
[[es:Rol de oficial de privacidad]]
[[de:Datenschutzbeauftragter-Rolle]]
[[ja:プライバシー責任者ロール]]

Navigation

2018-08-16T12:42:09Z

Mina: Link added.

{{Site appearance}}
==Navigation when using different themes==

When using the Clean or More theme, or a custom theme based on Clean, the navigation and administration blocks provide access to other pages on the site.

When using the Boost theme, or a custom theme based on it, access is instead provided via the navigation drawer.

== Navigation block==

The [[Navigation block]] provide easy access to '''view''' various sections of the Moodle site and includes
*Dashboard- a personalised home page displaying links to the courses a user is associated with and activity information (such as unread forum posts and upcoming assignments)
*Site pages - links to site pages and resources from the front page of Moodle
*My courses - expands to show courses the user is enrolled in.

===Keyboard support for navigation===

Keyboard/Screenreader and Voice input users can access navigation by using the Tab, Space, Enter and right/left arrow keys.

==Administration block==

The [[Administration block]] provides you with easy access to change various settings of a Moodle site. This block shows contextual settings (the settings for a forum when you are viewing it as an editing user) as well as settings for anything else you have permissions for.

==Site administration settings==

An administrator can change navigation settings, such as the default home page for users, and whether to show course categories in the navigation, in ''Administration > Site administration > Appearance > Navigation''.

If ''Show course full names'' is enabled, courses in the Navigation block will be shown with their full name rather than their short name.

If ''navshowcategories'' is enabled, but there is only one category on the site, it will not display in the navigation bar.

The setting ''Always link course sections'' can be enabled to link the course sections. When a section name is clicked either in the navigation block or the central course content area, it will go straight to the items in that section. When using the Boost theme, 'Always link course sections' must be enabled for course section links to display in the navigation drawer.

==Note for administrators==

If you are not ''directly'' associated with a course (that is, if you don't have a teacher, student or other role actually defined in the course) it will not appear in your Navigation menu. Also, if you are not directly associated with at least one course in a category, the category will not appear in your Navigation menu.

==See also==

* [https://moodle.org/mod/forum/discuss.php?d=374512 Disabling menu items] forum discussion

[[de:Navigation]]
[[es:Navegación]]
[[fr:Navigation]]

Activity restore

2018-08-07T14:03:10Z

Mina: Link added.

{{Reusing activities}}
==Restoring individual activities==
*It is possible to bring in or "restore" into a new Moodle activities that have been copied or [[Activity backup|''backed up'']] in a different Moodle. (Note that if you wish to re-use activities within the same Moodle it might be simpler to use the import function. See [[Import course data]] for information on how to do this.)
*To restore an activity you have backed up from another Moodle, ensure you have your backup file available (eg, on your computer or a USB pen) and ensure you are logged in with editing rights, as a teacher for example, and click the ''Restore'' link in the Course administration block:
*On the next screen, either drag and drop your backed up activity into the box with the arrow (''1 below'') or else click ''Choose a file'' to add it via the [[File picker]] (''2 below''); upload your backed up activity and click ''Restore''.

[[File:newrestore.png]]

*On the next screen, click ''Continue'' and then select the course into which you wish to restore your activity. Click ''Continue'' and then click'' Next.'' You will see your chosen activity:

[[File:Restoreassignment.png]]

*Click ''Next'' and on the next screen, click ''Perform restore''. Your activity will be added to your chosen course.

==Restoring a whole course==
*It is possible to restore a whole course rather than just individual activities. See [[Course restore]] for information on how to do this.

==See also==

* [[Restoring file aliases]]

[[de:Aktivitäten wiederherstellen]]
[[es:restauración de actividad]]
[[fr:Restauration d'activité]]

Activity backup

2018-08-07T13:42:17Z

Mina:

{{Reusing activities}}
==Backing up individual activities ==
*It is possible to make a copy or ''backup'' of individual activities in a Moodle course and then re-use these activities in a different Moodle site or in a different course on the same Moodle. (Note that if you wish to re-use activities within the same Moodle it might be simpler to use the ''import'' function. See [[Import course data]] for information on how to do this.
*To make a backup of an activity, ensure you are logged in with editing rights, as a teacher for example, and click on the activity you wish to backup. The settings block to the side will have a link ''Backup'' as with the assignment in the following screenshot:

[[File:Activitybackup1.png]]

*In the next screen, check/tick the type of item you wish to backup - in this case, just ''activities''

[[File:Includeactivities.png]]

*Click ''Next'' and on the next screen, check the activity you wish to backup - in this case, our assignment:

[[File:Backupassignment.png]]

*Click ''Next'' and on the next screen, if you wish, rename the filename (keeping its .mbz extension), check you have included the correct activity and click ''Perform backup.''
*You will get a message saying the backup file was successfully created. Click ''Continue'' and you will find your backup in the User Private backup area of the next screen:

[[File:Userprivatebackuparea.png]]

*You can download your file from here and then restore it to a course in another Moodle site. See [[Activity restore]] for infomation on how to do this.
'''NOTE:''' For security reasons, those with the teacher role are not able to backup user information belonging to activities so there will be a red cross and padlock next to any user information.

==Backing up whole courses==
*It is also possible to make a copy or backup of a whole course and re-use it elsewhere. See [[Course backup]] for information on how to do this. The process is the same as backing up a single activity as we have done here.

==Backup and restore of assignments from Moodle 2.2 and older==

The assignment activity module was completely rewritten in Moodle 2.3. Thus, assignments from Moodle 2.2 and older (e.g. from Moodle 1.9) need to be upgraded in order to continue being usable. See the section 'Restoring course backups from Moodle 2.2 and older' in [[Assignment upgrade tool]] for details of what to do.

==Activity backup capabilities==

There is just one capability, [[Capabilities/moodle/backup:backupactivity|Backup activities]], which is allowed for the default roles of manager and teacher.

[[de:Aktivitäten sichern]]
[[es:Respaldo de actividad]]
[[fr:Sauvegarde d'activité]]

Import course data

2018-08-07T13:38:05Z

Mina:

{{Reusing activities}}
Course activities and resources may be imported from any other course that the teacher has editing permissions in. This will allow teachers to re-use instead of re-creating one or more [[Activities|activities]] or [[Resources|resources]].

Import course data is similar to a backup and restore process and does not include any user data.

==How to import activities or resources==

*With the [[Boost theme]] click the gear/cogwheel icon top right of your course and then click "Import:

[[File:CourseImportBoost.png]]

If you are using a different theme, click ''Administration > Course Administration'', click on the ''Import'' link:

[[File:Importactivities.png]]

*Select the course you wish to import from and click ''Continue''.
*You will be presented with the "backup settings" page. Use the check boxes for import activities, blocks and or filters as types of items which will show on the next screen.

[[File:Importsettings.png]]

*Select the elements you want to include in the import in the Schema settings step.

[[File:Includeforimport.png]]

*Review and click ''Perform import'' or click the cancel or previous buttons. The confirmation page will place green check marks and red marks next to the backup settings and include item list for you to review.

[[File:Includeforimportconfirm.png]]

*You should see the "Import complete. Click continue to return to the course." message, or an error message indicating that the import process did not take place.

==Examples and tips==

*Importing a quiz from course A to course B, will also add the questions to the question bank so you can use them in new quizzes.
*''Tip:'' Groups can also be imported as a batch from a file.
* ''Tip:'' It may be necessary to check all Activities (Forums, Assignments, etc.) to assure they are now using HTML format. Due to the change in the HTML editor from 1.9 to 2.2, editing of Activities comes up as "Moodle Auto-format" which displays the HTML version of the Description. Once the "Moodle Auto-format" has been changed to "HTML format" the new HTML editor is available by default when editing.

==Import course capabilities==

* [[Capabilities/moodle/backup:backuptargetimport|Backup for import]] - allows a user to backup a course ready for importing into another course
* [[Capabilities/moodle/restore:restoretargetimport|Restore from files targeted as import]] - allows a user to import activities or resources from another course

==See also==
*[[Course backup]] & [[Course restore]] - for a similar process

[[fr:Importer des cours]]
[[de:Kursdaten importieren]]
[[es:Importar datos de curso]]
[[ja:コースデータをインポートする]]

MoodleBox

2018-07-23T19:08:57Z

Mina: /* New section */

{{Infobox plugin
|type = Admin Tool
|entry = https://moodle.org/plugins/view.php?plugin=tool_moodlebox
|tracker = https://tracker.moodle.org/browse/CONTRIB-6757
|discussion = N/A
|maintainer = [[User:Nicolas Martignoni|Nicolas Martignoni]]
|float = right
}}
The [https://moodle.org/plugins/view.php?plugin=tool_moodlebox MoodleBox plugin for Moodle] is an administration tool providing a GUI to some settings and management of a [https://moodlebox.net MoodleBox], a Moodle server installed on a [https://en.wikipedia.org/wiki/Raspberry_Pi Raspberry Pi].

It enables a Moodle administrator to monitor some hardware settings, to set the date of the [https://moodlebox.net MoodleBox], to allow restart and shutdown of the [https://moodlebox.net MoodleBox] and changing Raspberry Pi passwords using a GUI. After the installation in Moodle, some steps are required to complete on the Raspberry Pi (see below).

The plugin is compatible with Moodle 3.1 or later. A Raspberry Pi model 3B or 3B+ is recommended.

== Requirements ==

* A [https://en.wikipedia.org/wiki/Raspberry_Pi Raspberry Pi] (Model 3B or 3B+ recommended)
* [https://en.wikipedia.org/wiki/Raspbian Raspbian] installed (or another Linux based distribution)
* Package Incron installed
* Moodle installed (obviously)

== Installation==

The MoodleBox plugin must be installed in the Moodle tree of the [https://moodlebox.net MoodleBox], in the tool folder. Once installed, an new option MoodleBox will be available in Moodle, under ''Site administration > Server'' in the Administration block.

To complete the installation, you have to create some files in the plugin folder and configure some incron jobs on the MoodleBox.

=== Create necessary files ===

'''This step is not needed anymore for versions 1.10 or later'''

touch .reboot-server; touch .shutdown-server; touch .set-server-datetime; touch .newpassword; touch .wifisettings
chown -R www-data:www-data /var/www/moodle/admin/tool/moodlebox

=== Install incron package and allow root to run it ===
sudo apt-get install incron
echo root | sudo tee -a /etc/incron.allow

=== Add following lines to incrontab ===
/var/www/moodle/admin/tool/moodlebox/.reboot-server IN_CLOSE_WRITE /sbin/shutdown -r now
/var/www/moodle/admin/tool/moodlebox/.shutdown-server IN_CLOSE_WRITE /sbin/shutdown -h now
/var/www/moodle/admin/tool/moodlebox/.set-server-datetime IN_CLOSE_WRITE /bin/bash /var/www/moodle/admin/tool/moodlebox/.set-server-datetime
/var/www/moodle/admin/tool/moodlebox/.newpassword IN_CLOSE_WRITE /bin/bash /var/www/moodle/admin/tool/moodlebox/bin/changepassword.sh
/var/www/moodle/admin/tool/moodlebox/.wifisettings IN_CLOSE_WRITE /bin/bash /var/www/moodle/admin/tool/moodlebox/bin/changewifisettings.sh

=== Copy the following line at the end of file /etc/sudoers ===
www-data ALL=(ALL) NOPASSWD:/sbin/parted /dev/mmcblk0 unit MB print free

=== [[Secure Moodle on Raspberry Pi Model 2, Gentoo Linux and Nginx server|Secure your Moodlebox]] ===

== Features ==

* Info about the MoodleBox (kernel version, Raspbian version, free space on SD card, CPU load, CPU temperature, CPU frequency, uptime, DHCP clients).
* GUI to set the MoodleBox date and time.
* GUI to set the MoodleBox password.
* GUI to set the MoodleBox Wi-Fi network password, SSID and channel.
* GUI to restart and shutdown the MoodleBox.

== Availability ==

The code is available at [https://github.com/moodlebox/moodle-tool_moodlebox https://github.com/moodlebox/moodle-tool_moodlebox].

== See also ==

* [https://moodlebox.net MoodleBox documentation]

[[Category:Contributed code]]

[[es:MoodleBox]]

MoodleBox

2018-03-21T08:07:00Z

Mina:

{{Infobox plugin
|type = Admin Tool
|entry = https://moodle.org/plugins/view.php?plugin=tool_moodlebox
|tracker = https://tracker.moodle.org/browse/CONTRIB-6757
|discussion = N/A
|maintainer = [[User:Nicolas Martignoni|Nicolas Martignoni]]
|float = right
}}
The [https://moodle.org/plugins/view.php?plugin=tool_moodlebox MoodleBox plugin for Moodle] is an administration tool providing a GUI to some settings and management of a [https://moodlebox.net MoodleBox], a Moodle server installed on a [https://en.wikipedia.org/wiki/Raspberry_Pi Raspberry Pi].

It enables a Moodle administrator to monitor some hardware settings, to set the date of the [https://moodlebox.net MoodleBox], to allow restart and shutdown of the [https://moodlebox.net MoodleBox] and changing Raspberry Pi passwords using a GUI. After the installation in Moodle, some steps are required to complete on the Raspberry Pi (see below).

The plugin is compatible with Moodle 3.1 or later. A Raspberry Pi model 3B or 3B+ is recommended.

== Requirements ==

* A [https://en.wikipedia.org/wiki/Raspberry_Pi Raspberry Pi] (Model 3B or 3B+ recommended)
* [https://en.wikipedia.org/wiki/Raspbian Raspbian] installed (or another Linux based distribution)
* Package Incron installed
* Moodle installed (obviously)

== Installation==

The MoodleBox plugin must be installed in the Moodle tree of the [https://moodlebox.net MoodleBox], in the tool folder. Once installed, an new option MoodleBox will be available in Moodle, under ''Site administration > Server'' in the Administration block.

To complete the installation, you have to create some files in the plugin folder and configure some incron jobs on the MoodleBox.

=== Create necessary files ===

'''This step is not needed anymore for versions 1.10 or later'''

touch .reboot-server; touch .shutdown-server; touch .set-server-datetime; touch .newpassword; touch .wifisettings
chown -R www-data:www-data /var/www/moodle/admin/tool/moodlebox

=== Install incron package and allow root to run it ===
sudo apt-get install incron
echo root | sudo tee -a /etc/incron.allow

=== Add following lines to incrontab ===
/var/www/moodle/admin/tool/moodlebox/.reboot-server IN_CLOSE_WRITE /sbin/shutdown -r now
/var/www/moodle/admin/tool/moodlebox/.shutdown-server IN_CLOSE_WRITE /sbin/shutdown -h now
/var/www/moodle/admin/tool/moodlebox/.set-server-datetime IN_CLOSE_WRITE /bin/bash /var/www/moodle/admin/tool/moodlebox/.set-server-datetime
/var/www/moodle/admin/tool/moodlebox/.newpassword IN_CLOSE_WRITE /bin/bash /var/www/moodle/admin/tool/moodlebox/bin/changepassword.sh
/var/www/moodle/admin/tool/moodlebox/.wifisettings IN_CLOSE_WRITE /bin/bash /var/www/moodle/admin/tool/moodlebox/bin/changewifisettings.sh

=== [[Secure Moodle on Raspberry Pi Model 2, Gentoo Linux and Nginx server|Secure your Moodlebox]] ===

== Features ==

* Info about the MoodleBox (kernel version, Raspbian version, free space on SD card, CPU load, CPU temperature, CPU frequency, uptime, DHCP clients).
* GUI to set the MoodleBox date and time.
* GUI to set the MoodleBox password.
* GUI to set the MoodleBox Wi-Fi network password, SSID and channel.
* GUI to restart and shutdown the MoodleBox.

== Availability ==

The code is available at [https://github.com/moodlebox/moodle-tool_moodlebox https://github.com/moodlebox/moodle-tool_moodlebox].

== See also ==

* [https://moodlebox.net MoodleBox documentation]

[[Category:Contributed code]]

[[es:MoodleBox]]

MoodleBox

2018-03-16T12:54:27Z

Mina: /* Installation */ Fix error

{{Infobox plugin
|type = Admin Tool
|entry = https://moodle.org/plugins/view.php?plugin=tool_moodlebox
|tracker = https://tracker.moodle.org/browse/CONTRIB-6757
|discussion = N/A
|maintainer = [[User:Nicolas Martignoni|Nicolas Martignoni]]
|float = right
}}
The [https://moodle.org/plugins/view.php?plugin=tool_moodlebox MoodleBox plugin for Moodle] is an administration tool providing a GUI to some settings and management of a [https://moodlebox.net MoodleBox], a Moodle server installed on a [https://en.wikipedia.org/wiki/Raspberry_Pi Raspberry Pi].

It enables a Moodle administrator to monitor some hardware settings, to set the date of the [https://moodlebox.net MoodleBox], to allow restart and shutdown of the [https://moodlebox.net MoodleBox] and changing Raspberry Pi passwords using a GUI. After the installation in Moodle, some steps are required to complete on the Raspberry Pi (see below).

The plugin is compatible with Moodle 3.1 or later.

== Requirements ==

* A [https://en.wikipedia.org/wiki/Raspberry_Pi Raspberry Pi] (ideally Model 3 B)
* [https://en.wikipedia.org/wiki/Raspbian Raspbian] installed (or another Linux based distribution)
* Package Incron installed
* Moodle installed (obviously)

== Installation==

The MoodleBox plugin must be installed in the Moodle tree of the [https://moodlebox.net MoodleBox], in the tool folder. Once installed, an new option MoodleBox will be available in Moodle, under ''Site administration > Server'' in the Administration block.

To complete the installation, you have to create some files in the plugin folder and configure some incron jobs on the MoodleBox.

1 Create necessary files
touch .reboot-server; touch .shutdown-server; touch .set-server-datetime; touch .newpassword; touch .wifisettings
chown -R www-data:www-data /var/www/moodle/admin/tool/moodlebox
2 Install incron package and allow root to run it
sudo apt-get install incron
echo root | sudo tee -a /etc/incron.allow
3 Add following lines to incrontab
/var/www/moodle/admin/tool/moodlebox/.reboot-server IN_CLOSE_WRITE /sbin/shutdown -r now
/var/www/moodle/admin/tool/moodlebox/.shutdown-server IN_CLOSE_WRITE /sbin/shutdown -h now
/var/www/moodle/admin/tool/moodlebox/.set-server-datetime IN_CLOSE_WRITE /bin/bash /var/www/moodle/admin/tool/moodlebox/.set-server-datetime
/var/www/moodle/admin/tool/moodlebox/.newpassword IN_CLOSE_WRITE /bin/bash /var/www/moodle/admin/tool/moodlebox/bin/changepassword.sh
/var/www/moodle/admin/tool/moodlebox/.wifisettings IN_CLOSE_WRITE /bin/bash /var/www/moodle/admin/tool/moodlebox/bin/changewifisettings.sh

4 [[Secure Moodle on Raspberry Pi Model 2, Gentoo Linux and Nginx server|Secure your Moodlebox]]

== Features ==

* Info about the MoodleBox (kernel version, Raspbian version, free space on SD card, CPU load, CPU temperature, CPU frequency, uptime, DHCP clients).
* GUI to set the MoodleBox date and time.
* GUI to set the MoodleBox password.
* GUI to set the MoodleBox Wi-Fi network password, SSID and channel.
* GUI to restart and shutdown the MoodleBox.

== Availability ==

The code is available at [https://github.com/moodlebox/moodle-tool_moodlebox https://github.com/moodlebox/moodle-tool_moodlebox].

== See also ==

* [https://moodlebox.net MoodleBox documentation]

[[Category:Contributed code]]

[[es:MoodleBox]]

MoodleBox

2018-03-15T14:06:48Z

Mina: /* Availability */ url changed

{{Infobox plugin
|type = Admin Tool
|entry = https://moodle.org/plugins/view.php?plugin=tool_moodlebox
|tracker = https://tracker.moodle.org/browse/CONTRIB-6757
|discussion = N/A
|maintainer = [[User:Nicolas Martignoni|Nicolas Martignoni]]
|float = right
}}
The [https://moodle.org/plugins/view.php?plugin=tool_moodlebox MoodleBox plugin for Moodle] is an administration tool providing a GUI to some settings and management of a [https://moodlebox.net MoodleBox], a Moodle server installed on a [https://en.wikipedia.org/wiki/Raspberry_Pi Raspberry Pi].

It enables a Moodle administrator to monitor some hardware settings, to set the date of the [https://moodlebox.net MoodleBox], to allow restart and shutdown of the [https://moodlebox.net MoodleBox] and changing Raspberry Pi passwords using a GUI. After the installation in Moodle, some steps are required to complete on the Raspberry Pi (see below).

The plugin is compatible with Moodle 3.1 or later.

== Requirements ==

* A [https://en.wikipedia.org/wiki/Raspberry_Pi Raspberry Pi] (ideally Model 3 B)
* [https://en.wikipedia.org/wiki/Raspbian Raspbian] installed (or another Linux based distribution)
* Package Incron installed
* Moodle installed (obviously)

== Installation==

The MoodleBox plugin must be installed in the Moodle tree of the [https://moodlebox.net MoodleBox], in the tool folder. Once installed, an new option MoodleBox will be available in Moodle, under ''Site administration > Server'' in the Administration block.

To complete the installation, you have to create some files in the plugin folder and configure some incron jobs on the MoodleBox.

1 Create necessary files
touch .reboot-server; touch .shutdown-server; touch .set-server-datetime; touch .newpassword; touch .wifisettings
chown -R www-data:www-data /var/www/moodle/admin/tool/moodlebox
2 Install incron package and allow root to run it
sudo apt-get install incron
echo root | sudo tee -a /etc/incron.allow
3 Add following lines to incrontab
/var/www/moodle/admin/tool/moodlebox/.reboot-server IN_CLOSE_WRITE /sbin/shutdown -r now
/var/www/moodle/admin/tool/moodlebox/.shutdown-server IN_CLOSE_WRITE /sbin/shutdown -h now
/var/www/moodle/admin/tool/moodlebox/.set-server-datetime IN_CLOSE_WRITE /bin/bash /var/www/moodle/admin/tool/moodlebox/.set-server-datetime
/var/www/moodle/admin/tool/moodlebox/.newpassword IN_CLOSE_WRITE /bin/bash /var/www/moodle/admin/tool/moodlebox/bin/changepassword.sh
/var/www/moodle/admin/tool/moodlebox/.wifipassword IN_CLOSE_WRITE /bin/bash /var/www/moodle/admin/tool/moodlebox/bin/changewifisettings.sh

4 [[Secure Moodle on Raspberry Pi Model 2, Gentoo Linux and Nginx server|Secure your Moodlebox]]

== Features ==

* Info about the MoodleBox (kernel version, Raspbian version, free space on SD card, CPU load, CPU temperature, CPU frequency, uptime, DHCP clients).
* GUI to set the MoodleBox date and time.
* GUI to set the MoodleBox password.
* GUI to set the MoodleBox Wi-Fi network password, SSID and channel.
* GUI to restart and shutdown the MoodleBox.

== Availability ==

The code is available at [https://github.com/moodlebox/moodle-tool_moodlebox https://github.com/moodlebox/moodle-tool_moodlebox].

== See also ==

* [https://moodlebox.net MoodleBox documentation]

[[Category:Contributed code]]

[[es:MoodleBox]]

MoodleBox

2018-03-04T14:46:48Z

Mina: Links fixed, see also added.

{{Infobox plugin
|type = Admin Tool
|entry = https://moodle.org/plugins/view.php?plugin=tool_moodlebox
|tracker = https://tracker.moodle.org/browse/CONTRIB-6757
|discussion = N/A
|maintainer = [[User:Nicolas Martignoni|Nicolas Martignoni]]
|float = right
}}
The [https://moodle.org/plugins/view.php?plugin=tool_moodlebox MoodleBox plugin for Moodle] is an administration tool providing a GUI to some settings and management of a [https://moodlebox.net MoodleBox], a Moodle server installed on a [https://en.wikipedia.org/wiki/Raspberry_Pi Raspberry Pi].

It enables a Moodle administrator to monitor some hardware settings, to set the date of the [https://moodlebox.net MoodleBox], to allow restart and shutdown of the [https://moodlebox.net MoodleBox] and changing Raspberry Pi passwords using a GUI. After the installation in Moodle, some steps are required to complete on the Raspberry Pi (see below).

The plugin is compatible with Moodle 3.1 or later.

== Requirements ==

* A [https://en.wikipedia.org/wiki/Raspberry_Pi Raspberry Pi] (ideally Model 3 B)
* [https://en.wikipedia.org/wiki/Raspbian Raspbian] installed (or another Linux based distribution)
* Package Incron installed
* Moodle installed (obviously)

== Installation==

The MoodleBox plugin must be installed in the Moodle tree of the [https://moodlebox.net MoodleBox], in the tool folder. Once installed, an new option MoodleBox will be available in Moodle, under ''Site administration > Server'' in the Administration block.

To complete the installation, you have to create some files in the plugin folder and configure some incron jobs on the MoodleBox.

1 Create necessary files
touch .reboot-server; touch .shutdown-server; touch .set-server-datetime; touch .newpassword; touch .wifisettings
chown -R www-data:www-data /var/www/moodle/admin/tool/moodlebox
2 Install incron package and allow root to run it
sudo apt-get install incron
echo root | sudo tee -a /etc/incron.allow
3 Add following lines to incrontab
/var/www/moodle/admin/tool/moodlebox/.reboot-server IN_CLOSE_WRITE /sbin/shutdown -r now
/var/www/moodle/admin/tool/moodlebox/.shutdown-server IN_CLOSE_WRITE /sbin/shutdown -h now
/var/www/moodle/admin/tool/moodlebox/.set-server-datetime IN_CLOSE_WRITE /bin/bash /var/www/moodle/admin/tool/moodlebox/.set-server-datetime
/var/www/moodle/admin/tool/moodlebox/.newpassword IN_CLOSE_WRITE /bin/bash /var/www/moodle/admin/tool/moodlebox/bin/changepassword.sh
/var/www/moodle/admin/tool/moodlebox/.wifipassword IN_CLOSE_WRITE /bin/bash /var/www/moodle/admin/tool/moodlebox/bin/changewifisettings.sh

4 [[Secure Moodle on Raspberry Pi Model 2, Gentoo Linux and Nginx server|Secure your Moodlebox]]

== Features ==

* Info about the MoodleBox (kernel version, Raspbian version, free space on SD card, CPU load, CPU temperature, CPU frequency, uptime, DHCP clients).
* GUI to set the MoodleBox date and time.
* GUI to set the MoodleBox password.
* GUI to set the MoodleBox Wi-Fi network password, SSID and channel.
* GUI to restart and shutdown the MoodleBox.

== Availability ==

The code is available at [https://github.com/martignoni/moodle-tool_moodlebox https://github.com/martignoni/moodle-tool_moodlebox].

== See also ==

* [https://moodlebox.net MoodleBox documentation]

[[Category:Contributed code]]

[[es:MoodleBox]]

Grade import

2018-02-16T10:42:07Z

Mina: Link fixed

{{Grades}}
==Importing grades==
Grades may be imported as a CSV or XML file, or by pasting from a spreadsheet.

The import file format is the same as the corresponding export format.

'''Note 1:''' Grade import is equivalent to manual grading in the [[Grader report|grader report]]. Thus, if grades for a particular Moodle activity such as an assignment are imported, they can no longer be edited via the assignment submission page.

'''Note 2:''' To import grades above 100% you need to check the 'unlimitedgrades' and 'gradepointmax' settings in ''Site administration>Administration>Grades>General settings''.

'''Note 3:''' Importing feedback will also overwrite any grades that are linked to that assessment. Please include both feedback and grades for the activity when mapping and importing grades via CSV. If both columns are not included then all grades for that activity will be lost.

[[Image:Csv grade import.png|thumb|CSV grade import]]
To import grades into the gradebook:

# Decide on an import format - CSV or XML file, or paste from spreadsheet (see below) - then [[Grade export|export some grades]] using the corresponding export format.
# Edit the export file as appropriate and save it.
# Tip: If you opened your exported file in Excel, don't add columns there because Moodle will reject the import if there are new columns that didn't exist in the exported file. If you need to add columns, do that in Moodle BEFORE you export your gradebook.
# Select your chosen import format from the gradebook dropdown menu.
# Browse and upload your previously saved file.
# Set options as required.
# Click the "Upload grades" button.
# CSV import only: Preview the grade import and choose the column mapping then click the "Upload grades" button to complete the grade import.
## Tip: By default "Map from" is set to First Name, and "Map to" to userid. Change both dropdowns to: "Email Address" to "useremail", or to "Id Number" to "useridnumber" (assuming that your users have ID number fields filled in in their profiles).
## Tip: Unlike in most email programs, email addresses are case sensitive in grade import files. (This should eventually be fixed as per MDL-29315.)

You need two permissions to import grades: (1) general permission to import grades and (2) permission to import grades in a particular format. For example, to import CSV grades you need moodle/grade:import ("Import grades") = Allow and gradeimport/csv:view ("Import grades from CSV") = Allow

==CSV import==

CSV import is more flexible than XML import, as you may choose the column mapping.

===Grade Mapping===

After selecting your CSV for import you'll be prompted to map user fields and grade items to the new column headers to ensure that there is a match. More than one item can be mapped to the same grade item in your destination course so be mindful of the mapping to ensure that grade data is imported properly, any collisions (i.e. if two or more fields are mapped to the same but duplicate data exists) will cause an error. User grade data for users not yet enrolled to the destination course will be noted (and once enrolled their grade data will display).

===Encoding===

If you are unsure of the encoding of your CSV file, try selecting the second option in the encoding dropdown menu. If you've used Excel to produce the CSV file the second option WINDOWS-xxx encoding is probably the correct one. The grade import preview will tell you if you guessed the encoding correctly.

===Verbose scales===

Scales can be either specified as a raw id - eg. 0, 1, 2, 3, etc. or as a string, eg. "good", "bad", "not very bad". The later format is called "verbose".

===Force import===

This prevents grade overriding during the grade importing in a scenario where more than one teacher exports the course grades and then re-imports them. If a second teacher exports the grades and tries to import them, the following error message will be displayed and the grade importing procedure will be aborted:
<pre>(''Student name'') grades have not been imported because the grades in the import file are older than in the grader report. To proceed with the grade import anyway, use the force import option.</pre>

It will not be possible to import a file that had been exported file longer than a year ago, one with dates in the future. However, in cases where a teacher needs to import the grades regardless, they should use the '''Force import'''. option. This will then import the grades irrespective of the dates.

==Paste from spreadsheet==

Grades may be pasted directly from a spreadsheet such as Excel or Libre Office:

1) Ensure you have the correct column names for your grades (eg the assignment title or manual grade) It might help to download and edit the relevant students and graded information by using the [[Grade export]] feature.

2) For the students you need either their username, their ID or their email address. Add the grades you need and copy the relevant section:
[[File:pastegrades1.png|thumb|center|400px]]
3) In your course, go to ''Grade administration>Import>Paste from spreadsheet'' and paste:
[[File:pastegrades2.png|thumb|center|400px]]
4) In the preview, ensure you match up the identifier you used for the students -so if you used 'username', ensure it maps to 'username'. Do the same for your graded activities:
[[File:pastegrades3.png|thumb|400px|center]]
5) If everything has been correctly mapped (See grade mapping above), you should get a success message and the grades will have been added, displaying in a different colour to show they were imported directly into the gradebook:
{|
| [[File:pastegrades4.png|thumb|400px]]
| [[File:pastegrades5.png|thumb|400px]]
|}

Paste from a spreadsheet requires similar permissions to a csv file import: (1) general permission to import grades and (2) permission to import grades in a particular format i.e. moodle/grade:import ("Import grades") = Allow and gradeimport/direct:view ("Import grades from spreadsheet") = Allow

==XML import==

Before importing an XML file you will need to ensure that all of the students that you want to alter grades for have their ID number field filled out. This is located in the "Optional" section of the user edit profile page.
You will also need to set the ID number of the activity as well. You can find this under "Common module settings" when editing the activity.

The format for the XML should be as follows:
<pre>
<results>
<result>
<assignment>activityidnumber</assignment>
<student>studentidnumber</student>
<score>53.00</score>
</result>
<result>
<assignment>differentactivityidnumber</assignment>
<student>studentidnumber</student>
<score>73.00</score>
</result>
</results>
</pre>

For a working example try exporting the gradebook as an xml file and view the format.

===Remote file URL===

The remote file URL field is for fetching data from a remote server, such as a student information system.

==Grade import capabilities==

* [[Capabilities/gradeimport/csv:view|Import grades from CSV]]
* [[Capabilities/gradeimport/xml:publish|Publish import grades from XML]]
* [[Capabilities/gradeimport/xml:view|Import grades from XML]]

==See also==

Using Moodle forum discussions:
*[http://moodle.org/mod/forum/discuss.php?d=85944 Gradebook confusion]
*[http://moodle.org/mod/forum/discuss.php?d=92081 Can external software insert data into the gradebook?]

[[ja:評定のインポート]]
[[de:Bewertungen importieren]]
[[es:Importar calificaciones]]
[[fr:Importation de notes]]

Standard Moodle tags

2017-12-09T18:00:23Z

Mina: /* Tags in use */

Tags are useful for connecting different bits of information together.

Obviously it's important to use the same tags everywhere.

This page describes standard Moodle tags that you should use when describing Moodle events on the internet (Flickr, Twitter, Facebook, del.icio.us etc)

==General Moodle stuff==

For general discussion of Moodle, use the tag "moodle".

Twitter example:
I just installed #moodle on a computer I bought ten years ago!

==Moodle Moots==

For Moodle conferences (Moots) use mootCCYY where:
* CC is a country ISO code or state abbreviation, and
* YY is a year.

mootAU09

Capitalisation doesn't matter and just helps readability.

The two letter code would usually be a country, but for somewhere like the US where there are different moots they might choose to use "us" or a state like "sf" or "ok". It really doesn't matter if two moots both used mootus09 for example, because they would be separated in time.

==Tags in use==

* #mooteu09 MoodleMoot Euskadi
* #mootNL09 Amsterdam Moodlemoot
* #mootUS09ok Moodlemoot Oklahoma (or #mootok09)
* #mootUS09SF Moodlemoot San Francisco (or #mootsf09)
* #mootin09 Goshen Midwest MoodleMoot
* #mootus09ny MoodleMoot Delhi (or #mootny09)
* #mootar09 MoodleMoot Argentina
* #mootat09 MoodleMoot Austria
* #mootDE09 MoodleMoot Germany 2009
* #mootco09 MoodleMoot Colombia
* #mootcl09 MoodleMoot Chile
* #mootes09 MoodleMoot Spain 2009
* #moodle #OE09 Moodle at Online Educa 2009 in Berlin (December)
* #moodledev09 [[Development:Czech Hackfest 2009|Czech Hackfest 2009]]
* #imoot and #imoot2010 iMoot 2010
* #mootJP10hk Moodlemoot Japan in Hakodate, February 2010
* #mootDE10b Moodlemoot Germany 2010 in Berlin March
* #mootDE10e [http://moodle2010.de/ Moodlemoot Germany 2010 in Essen] 16-17 September 2010
* #mootNZ10 Moodle Moot New Zealand (Christchurch) April 2010
* #mootUK10 MoodleMoot UK April 2010
* #mootsi10 Slovenian MoodleMoot
* #mootok10 MoodleMoot Oklahoma
* #mootau10 MoodleMoot AU 2010
* #mootcz10 [http://www.moodlemoot.cz/ MoodleMoot Czech Republic, Brno] 10-11 June 2010
* #mootfr10 6th French MoodleMoot
* #mootIT10 MoodleMoot Italia 2010
* #mootnl10 MoodleMoot NL 2010
* #mootPL10 Second Polish MoodleMoot, 4-5 November 2010, Czestochowa, Poland, http://moodlemoot.pl
* #mootusin10 Goshen, Indiana, USA 26-28 July, 2010
* #mootustx10 Austin, Texas, USA 2-3 August, 2010
* #mootfr11 [http://moodlemoot2011.uvt.rnu.tn/ 7th French MoodleMoot], Hammamet, Tunisia, 27-29 June 2011
* #mootde12 [http://moodlemoot.de/ German Moodlemoot], Münster, Germany, 13-16 March 2012
* #mootfr12 [http://moodlemoot2012.unimes.fr/ 8th French MoodleMoot], Nîmes, France, 20-22 June 2012
* #mootde13 [http://moodlemoot.de/ German Moodlemoot], München, Germany, 28 Feb - 1 Mar 2013
* #mootfr13 [http://moodlemoot2013.univ-bordeaux.fr/ 9th French MoodleMoot], Bordeaux, France, 5-7 June 2013
* #smootau13 [http://http://school.moodlemoot.com.au/ 2nd Australian Schoolmoot], Sydney, Australia, 2-4 October 2013
* #mootfr14 [http://moodlemoot2014.univ-paris3.fr 10th French MoodleMoot], Paris, 4-6 June 2014
* #mootfr15 [https://moodlemoot2015.univ-tours.fr 11th French MoodleMoot], Tours, 10-12 June 2015
* #mootfr16 [http://2016.moodlemoot.fr 12th French MoodleMoot], Sierre, Switzerland, 6-8 July 2016
* #mootfr17 [http://2017.moodlemoot.fr 13th French MoodleMoot], Lyon, 28-30 June 2017
* #mootfr18 [https://2018.moodlemoot.fr 14th French MoodleMoot], Bruxelles, 4-6 July 2017

==See also==

* Lounge discussion [http://moodle.org/mod/forum/discuss.php?d=121619 A standard naming scheme for Moodle hashtags]

Standard Moodle tags

2017-12-09T17:57:34Z

Mina: /* Tags in use */ French MM2018 added

Tags are useful for connecting different bits of information together.

Obviously it's important to use the same tags everywhere.

This page describes standard Moodle tags that you should use when describing Moodle events on the internet (Flickr, Twitter, Facebook, del.icio.us etc)

==General Moodle stuff==

For general discussion of Moodle, use the tag "moodle".

Twitter example:
I just installed #moodle on a computer I bought ten years ago!

==Moodle Moots==

For Moodle conferences (Moots) use mootCCYY where:
* CC is a country ISO code or state abbreviation, and
* YY is a year.

mootAU09

Capitalisation doesn't matter and just helps readability.

The two letter code would usually be a country, but for somewhere like the US where there are different moots they might choose to use "us" or a state like "sf" or "ok". It really doesn't matter if two moots both used mootus09 for example, because they would be separated in time.

==Tags in use==

* #mooteu09 MoodleMoot Euskadi
* #mootNL09 Amsterdam Moodlemoot
* #mootUS09ok Moodlemoot Oklahoma (or #mootok09)
* #mootUS09SF Moodlemoot San Francisco (or #mootsf09)
* #mootin09 Goshen Midwest MoodleMoot
* #mootus09ny MoodleMoot Delhi (or #mootny09)
* #mootar09 MoodleMoot Argentina
* #mootat09 MoodleMoot Austria
* #mootDE09 MoodleMoot Germany 2009
* #mootco09 MoodleMoot Colombia
* #mootcl09 MoodleMoot Chile
* #mootes09 MoodleMoot Spain 2009
* #moodle #OE09 Moodle at Online Educa 2009 in Berlin (December)
* #moodledev09 [[Development:Czech Hackfest 2009|Czech Hackfest 2009]]
* #imoot and #imoot2010 iMoot 2010
* #mootJP10hk Moodlemoot Japan in Hakodate, February 2010
* #mootDE10b Moodlemoot Germany 2010 in Berlin March
* #mootDE10e [http://moodle2010.de/ Moodlemoot Germany 2010 in Essen] 16-17 September 2010
* #mootNZ10 Moodle Moot New Zealand (Christchurch) April 2010
* #mootUK10 MoodleMoot UK April 2010
* #mootsi10 Slovenian MoodleMoot
* #mootok10 MoodleMoot Oklahoma
* #mootau10 MoodleMoot AU 2010
* #mootcz10 [http://www.moodlemoot.cz/ MoodleMoot Czech Republic, Brno] 10-11 June 2010
* #mootfr10 6th French MoodleMoot
* #mootIT10 MoodleMoot Italia 2010
* #mootnl10 MoodleMoot NL 2010
* #mootPL10 Second Polish MoodleMoot, 4-5 November 2010, Czestochowa, Poland, http://moodlemoot.pl
* #mootusin10 Goshen, Indiana, USA 26-28 July, 2010
* #mootustx10 Austin, Texas, USA 2-3 August, 2010
* #mootfr11 [http://moodlemoot2011.uvt.rnu.tn/ 7th French MoodleMoot], Hammamet, Tunisia, 27-29 June 2011
* #mootde12 [http://moodlemoot.de/ German Moodlemoot], Münster, Germany, 13-16 March 2012
* #mootfr12 [http://moodlemoot2012.unimes.fr/ 8th French MoodleMoot], Nîmes, France, 20-22 June 2012
* #mootde13 [http://moodlemoot.de/ German Moodlemoot], München, Germany, 28 Feb - 1 Mar 2013
* #mootfr13 [http://moodlemoot2013.univ-bordeaux.fr/ 9th French MoodleMoot], Bordeaux, France, 5-7 June 2013
* #smootau13 [http://http://school.moodlemoot.com.au/ 2nd Australian Schoolmoot], Sydney, Australia, 2-4 October 2013
* #mootfr14 [http://moodlemoot2014.univ-paris3.fr 10th French MoodleMoot], Paris, 4-6 June 2014
* #mootfr15 [https://moodlemoot2015.univ-tours.fr 11th French MoodleMoot], Tours, 10-12 June 2015
* #mootfr16 [http://2016.moodlemoot.fr 12th French MoodleMoot], Sierre, Switzerland, 6-8 July 2016
* #mootfr17 [http://2017.moodlemoot.fr 13th French MoodleMoot], Lyon, 28-30 June 2017
* #mootfr18 [http://2018.moodlemoot.fr 14th French MoodleMoot], Bruxelles, 4-6 July 2017

==See also==

* Lounge discussion [http://moodle.org/mod/forum/discuss.php?d=121619 A standard naming scheme for Moodle hashtags]

MoodleBox

2017-09-05T17:18:06Z

Mina: /* Features */ Version 1.6

{{Infobox plugin
|type = Admin Tool
|entry = https://moodle.org/plugins/view.php?plugin=tool_moodlebox
|tracker = https://tracker.moodle.org/browse/CONTRIB-6757
|discussion = N/A
|maintainer = [[User:Nicolas Martignoni|Nicolas Martignoni]]
|float = right
}}
The [https://moodle.org/plugins/view.php?plugin=tool_moodlebox MoodleBox plugin for Moodle] is an administration tool providing a GUI to some settings and management of a [https://github.com/martignoni/make-moodlebox MoodleBox], a Moodle server installed on a [https://en.wikipedia.org/wiki/Raspberry_Pi Raspberry Pi].

It enables a Moodle administrator to monitor some hardware settings, to set the date of the MoodleBox, to allow restart and shutdown of the MoodleBox and changing Raspberry Pi passwords using a GUI. After the installation in Moodle, some steps are required to complete on the Raspberry Pi (see below).

The plugin is compatible with Moodle 3.1 or later.

== Requirements ==

* A [https://en.wikipedia.org/wiki/Raspberry_Pi Raspberry Pi] (ideally Model 3 B)
* [https://en.wikipedia.org/wiki/Raspbian Raspbian] installed (or another Linux based distribution)
* Package Incron installed
* Moodle installed (obviously)

== Installation==

The MoodleBox plugin must be installed in the Moodle tree of the MoodleBox, in the tool folder. Once installed, an new option MoodleBox will be available in Moodle, under ''Site administration > Server'' in the Administration block.

To complete the installation, you have to create some files in the plugin folder and configure some incron jobs on the MoodleBox.

1 Create necessary files
touch .reboot-server; touch .shutdown-server; touch .set-server-datetime; touch .newpassword; touch .wifisettings
chown -R www-data:www-data /var/www/moodle/admin/tool/moodlebox
2 Install incron package and allow root to run it
sudo apt-get install incron
echo root | sudo tee -a /etc/incron.allow
3 Add following lines to incrontab
/var/www/moodle/admin/tool/moodlebox/.reboot-server IN_CLOSE_WRITE /sbin/shutdown -r now
/var/www/moodle/admin/tool/moodlebox/.shutdown-server IN_CLOSE_WRITE /sbin/shutdown -h now
/var/www/moodle/admin/tool/moodlebox/.set-server-datetime IN_CLOSE_WRITE /bin/bash /var/www/moodle/admin/tool/moodlebox/.set-server-datetime
/var/www/moodle/admin/tool/moodlebox/.newpassword IN_CLOSE_WRITE /bin/bash /var/www/moodle/admin/tool/moodlebox/bin/changepassword.sh
/var/www/moodle/admin/tool/moodlebox/.wifipassword IN_CLOSE_WRITE /bin/bash /var/www/moodle/admin/tool/moodlebox/bin/changewifisettings.sh

4 [[Secure Moodle on Raspberry Pi Model 2, Gentoo Linux and Nginx server|Secure your Moodlebox]]

== Features ==

* Info about the MoodleBox (kernel version, Raspbian version, free space on SD card, CPU load, CPU temperature, CPU frequency, uptime, DHCP clients).
* GUI to set the MoodleBox date and time.
* GUI to set the MoodleBox password.
* GUI to set the MoodleBox Wi-Fi network password, SSID and channel.
* GUI to restart and shutdown the MoodleBox.

== Availability ==

The code is available at [https://github.com/martignoni/moodle-tool_moodlebox https://github.com/martignoni/moodle-tool_moodlebox].

[[Category:Contributed code]]

[[es:MoodleBox]]

MoodleBox

2017-09-05T17:16:58Z

Mina: Version 1.6 update

{{Infobox plugin
|type = Admin Tool
|entry = https://moodle.org/plugins/view.php?plugin=tool_moodlebox
|tracker = https://tracker.moodle.org/browse/CONTRIB-6757
|discussion = N/A
|maintainer = [[User:Nicolas Martignoni|Nicolas Martignoni]]
|float = right
}}
The [https://moodle.org/plugins/view.php?plugin=tool_moodlebox MoodleBox plugin for Moodle] is an administration tool providing a GUI to some settings and management of a [https://github.com/martignoni/make-moodlebox MoodleBox], a Moodle server installed on a [https://en.wikipedia.org/wiki/Raspberry_Pi Raspberry Pi].

It enables a Moodle administrator to monitor some hardware settings, to set the date of the MoodleBox, to allow restart and shutdown of the MoodleBox and changing Raspberry Pi passwords using a GUI. After the installation in Moodle, some steps are required to complete on the Raspberry Pi (see below).

The plugin is compatible with Moodle 3.1 or later.

== Requirements ==

* A [https://en.wikipedia.org/wiki/Raspberry_Pi Raspberry Pi] (ideally Model 3 B)
* [https://en.wikipedia.org/wiki/Raspbian Raspbian] installed (or another Linux based distribution)
* Package Incron installed
* Moodle installed (obviously)

== Installation==

The MoodleBox plugin must be installed in the Moodle tree of the MoodleBox, in the tool folder. Once installed, an new option MoodleBox will be available in Moodle, under ''Site administration > Server'' in the Administration block.

To complete the installation, you have to create some files in the plugin folder and configure some incron jobs on the MoodleBox.

1 Create necessary files
touch .reboot-server; touch .shutdown-server; touch .set-server-datetime; touch .newpassword; touch .wifisettings
chown -R www-data:www-data /var/www/moodle/admin/tool/moodlebox
2 Install incron package and allow root to run it
sudo apt-get install incron
echo root | sudo tee -a /etc/incron.allow
3 Add following lines to incrontab
/var/www/moodle/admin/tool/moodlebox/.reboot-server IN_CLOSE_WRITE /sbin/shutdown -r now
/var/www/moodle/admin/tool/moodlebox/.shutdown-server IN_CLOSE_WRITE /sbin/shutdown -h now
/var/www/moodle/admin/tool/moodlebox/.set-server-datetime IN_CLOSE_WRITE /bin/bash /var/www/moodle/admin/tool/moodlebox/.set-server-datetime
/var/www/moodle/admin/tool/moodlebox/.newpassword IN_CLOSE_WRITE /bin/bash /var/www/moodle/admin/tool/moodlebox/bin/changepassword.sh
/var/www/moodle/admin/tool/moodlebox/.wifipassword IN_CLOSE_WRITE /bin/bash /var/www/moodle/admin/tool/moodlebox/bin/changewifisettings.sh

4 [[Secure Moodle on Raspberry Pi Model 2, Gentoo Linux and Nginx server|Secure your Moodlebox]]

== Features ==

* Info about the MoodleBox (kernel version, Raspbian version, free space on SD card, CPU load, CPU temperature, CPU frequency, uptime, DHCP clients).
* GUI to set the MoodleBox date and time.
* GUI to set the MoodleBox password.
* GUI to set the MoodleBox Wi-Fi network password.
* GUI to restart and shutdown the MoodleBox.

== Availability ==

The code is available at [https://github.com/martignoni/moodle-tool_moodlebox https://github.com/martignoni/moodle-tool_moodlebox].

[[Category:Contributed code]]

[[es:MoodleBox]]

Användare:Nicolas Martignoni

2017-07-23T14:24:52Z

Mina: /* Some useful pages */

== My activities around Moodle ==

* In charge of the french translation of Moodle
* Management of the community ''[http://moodle.org/course/view.php?id=20 Moodle en français]'' on moodle.org
* Sysop of french [[:fr:Accueil|Moodle Docs]]
* Moodle on Raspberry project: [https://moodlebox.net/ MoodleBox]
* My [http://moodle.org/user/view.php?id=6406&course=5 user profile] on moodle.org

=== Some useful pages ===

* [https://docs.moodle.org/400/sv/Special:AllPages?namespace=10 Templates]
* [[Special:Categories|Categories]]

[[fr:User:Nicolas Martignoni]]

Användare:Nicolas Martignoni

2017-07-23T14:23:49Z

Mina:

== My activities around Moodle ==

* In charge of the french translation of Moodle
* Management of the community ''[http://moodle.org/course/view.php?id=20 Moodle en français]'' on moodle.org
* Sysop of french [[:fr:Accueil|Moodle Docs]]
* Moodle on Raspberry project: [https://moodlebox.net/ MoodleBox]
* My [http://moodle.org/user/view.php?id=6406&course=5 user profile] on moodle.org

=== Some useful pages ===

* [https://docs.moodle.org/400/sv/Special:AllPages?namespace=10 Templates]
* [[Special:Categories|Categories]]
* [[Special:Disambiguations|Disambiguations]]

[[fr:User:Nicolas Martignoni]]