MoodleDocs - User contributions [en]

Privacy officer role

2018-10-22T11:25:25Z

Demsley: /* Role assignment */

{{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. ( Users --> Permissions --> Define Roles)
# 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. (Users --> Privacy and policies --> Privacy settings)
# 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. (Users --> Permissions --> Assign system roles)
# 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:プライバシー責任者ロール]]

Privacy officer role

2018-10-22T11:24:36Z

Demsley: /* Role set-up */

{{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. ( Users --> Permissions --> Define Roles)
# 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. (Users --> Privacy and policies --> Privacy settings)
# 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:プライバシー責任者ロール]]

Privacy officer role

2018-10-22T11:16:21Z

Demsley: /* Role set-up */

{{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. ( Users --> Permissions --> Define Roles)
# 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:プライバシー責任者ロール]]

Policies

2018-09-03T12:38:07Z

Demsley: /* Enabling the policies plugin */

{{GDPR}}{{New features}}
The Policies plugin provides a new user sign-on process, with ability to define multiple policies (site, privacy, third party), track user consents, and manage updates and versioning of the policies.

The Policies plugin forms part of Moodle’s privacy feature set assisting sites to become GDPR compliant.

==Enabling the policies plugin==

To enable the policies plugin

# Go to 'Policy settings' in the Site administration.
# Set the Site policy handler to 'Policies (tool_policy)'.
# Save changes.

Two new pages will then appear in the Site administration - 'Manage policies' and 'User agreements'.

(Note: In my setup these are in Site Admininstration > Users > Privacy and Policies but I did not feel confident editing the above out)

Note that when Policies is set as the site policy handler, the settings 'Site policy' and 'Site policy for guests' are ignored.

==Adding and managing policies==
[[File:policies and agreements.png|thumb|Policies and agreements]]
An admin or any user with the [[Capabilities/tool/policy:managedocs|Manage policies]] capability (by default manager) can access the page 'Manage policies' in the Site administration and:

* Add a new site / privacy / third parties / other policy for all users, authenticated users or guests
* Change the active / inactive status of each policy
* View the number and percentage of users who have agreed to each policy
* Edit a policy and specify whether it is a minor change (not requiring users to reconfirm their consent) or not
* View the current version of each policy and also previous versions
* Change the order in which policies are shown to users

To add a new policy:

# Go to 'Manage policies' in the Site administration.
# Click the button 'New policy'
# Complete the form and save changes.

Note that once created, a policy can be edited, or set to inactive, but if users have agreed to it, it can't be deleted.

The policy type (site / privacy / third parties) is only displayed at the 'Policies' page linked on the footer and the behaviour is the same for all the policy types.

==Giving consent to policies==
[[File:Agreeing to policies.png|thumb|Giving consent to policies]]
All users (with the exception of admins) will be required to give their consent to all policies defined either for “Authenticated users” or for “All users” before proceeding further on the site.

If a new policy is added, all users will be required to give their consent when they next log in. Similarly, if an existing policy is edited and is not marked as a minor change, all users will be required to give their consent when they next log in.

If self-registration is enabled on the site, new users will be required to give their consent to all policies before proceeding to the sign-up form. If digital age of consent verification (a new setting in Moodle 3.4.2 onwards) is enabled in '[[Privacy|Privacy settings]]' in the Site administration, when a new user clicks the 'Create new account' button, they will be prompted to enter their age and country. If the user's age is lower than the age of consent for their country, they will see a message prompting them to ask their parent/guardian to contact the support contact (as specified in 'Support contact' in the Site administration).

==Policies for guests==
[[File:policies modal window.png|thumb|Policies for guests modal window]]
If a user logs in as a [[Guest access|guest]], a modal window will be shown at the bottom of the user's browser window with links to all policies defined either for guests or for all users.

==Minors==
[[File:No permission to agree to policies.png|thumb|Minor prevented from proceeding further on the site]]
Users who are younger than the age of digital consent, called 'minors', may be prevented from giving their consent by prohibiting the capability [[Capabilities/tool/policy:accept|Agree to policies]]. They will then be prevented from proceeding further on the site until someone can give consent on their behalf.

===Sites with minors as the majority of users===

To prohibit users from agreeing to policies because they are a minor:

# Go to 'Define roles' in the Site administration.
# Edit the role of authenticated user and set [[Capabilities/tool/policy:accept|Agree to policies]] to prohibit.
# Save changes.

To enable teachers and other users who are not minors to agree to policies:

# Go to 'Define roles' in the Site administration.
# Click the button 'Add a new role'.
# Give the role a name such as 'Able to give consent', short name and description.
# For context types where this role may be assigned, tick system.
# Enter policy in the filter box, then allow the capability Agree to policies.
# Click the button 'Create this role'.
# Go to 'Assign system roles' in the Site administration.
# Choose the 'Able to give consent' role to assign.
# Select teachers and other users in the Potential users list, and use the left-facing arrow button to add them to the Existing users list.

===Sites with only a few minors===

To prohibit users from agreeing to policies because they are a minor:

# Go to 'Define roles' in the Site administration.
# Click the button 'Add a new role'.
# Give the role a name such as 'Digital minor', short name and description.
# For context types where this role may be assigned, tick system.
# Enter policy in the filter box, then prohibit the capability Agree to policies.
# Click the button 'Create this role'.
# Go to 'Assign system roles' in the Site administration.
# Choose the 'Digital minor' role to assign.
# Select minors in the Potential users list, and use the left-facing arrow button to add them to the Existing users list.

==User agreements==
[[File:user agreements.png|thumb|User agreements filtered to show minors]]
An admin or any user with the [[Capabilities/tool/policy:viewacceptances|View user agreements reports]] capability (by default manager) can access the page 'User agreements' in the Site administration and:

* View user consents
* Filter by policy, permission, status or role
* Give consent on behalf of minors
* Download table data

User agreements for a particular policy may also be viewed via the 'Manage policies' page by clicking the link in the Agreements column.

==Giving consent on behalf of other users==

An admin or any user with the capability [[Capabilities/tool/policy:acceptbehalf|Agree to the policies on someone else's behalf]] can give consent on behalf of minors or when a written consent was obtained offline.

===Giving consent on behalf of multiple users===
[[File:Record of consents.png|thumb|Record of consents with remarks]]
Users with capability [[Capabilities/tool/policy:acceptbehalf|Agree to the policies on someone else's behalf]] in the system context, such as managers, can give consent on behalf of multiple users as follows:

# Go to 'User agreements' in the Site administration.
# If necessary, filter by 'Permission: Can not agree'.
# To give consent for multiple policies, tick the box next to selected users' names then click the consent button.
# To give consent for a single policy, click the red cross next to the user's name.

When giving consent on behalf of other users, there is an opportunity to add some remarks. Clicking on the link in the Overall column gives an overview with details of who gave consent and when, together with any remarks.

It's not yet possible to give consent in bulk, however a workaround would be to install and use a browser extension for checking all checkboxes on the page.

===Giving consent on behalf of a child===

A parent or guardian may be allowed to give consent on behalf of their child by giving them the capability [[Capabilities/tool/policy:acceptbehalf|Agree to the policies on someone else's behalf]] in the user context. See the [[Parent role]] for details of how to create the role and assign a parent to a student. The parent or guardian will then be able to give consent as follows:

# Go to the child's profile page.
# Click the link 'Policies and agreements'.
# Click the red cross next to the policy name.

==Capabilities==

* [[Capabilities/tool/policy:accept|Agree to policies]] - allowed for authenticated user role
* [[Capabilities/tool/policy:managedocs|Manage policies]] - allowed for default role of manager only
* [[Capabilities/tool/policy:viewacceptances|View user agreements reports]] - allowed for default role of manager only
* [[Capabilities/tool/policy:acceptbehalf|Agree to policies on someone else's behalf]] - allowed for default role of manager only

[[Category:Privacy]]

[[es:Plugin de políticas]]
[[de:Richtlinien-Plugin]]

bootstrap-Theme

2017-10-24T10:35:09Z

Demsley: Speelling error corrected.

== Twitter Bootstrap Theme==
This page aims to bring together discussions from the themes forum related to the development of a moodle 'base' theme that conforms to the [http://twitter.github.com/bootstrap/ Twitter Bootstrap] coding conventions. There has already been a great deal of work done by individuals within the Moodle community and it's hoped that by formulating this work we may be able to collaborate and build on this.

== Technical Approach ==
There are 5 major categories of development for this theme family:

* Layouts
* Renderers
* Stylesheets
* Javascripts
* Settings (child themes)

=== Layout ===
The General layout will be a 2 column layout based on the [http://twitter.github.com/bootstrap/examples/fluid.html "Fluid" example] providing an "out of the box" responsive grid.

=== Renderers ===
Multiple renderers will be developed to make Moodle output more bootstrap friendly by 1) outputting classes defined in bootstrap.css and 2) outputting semantic HTML exemplified in the bootstrap documentation

=== Stylesheets ===
Bootstrap.css will be the core CSS sheet with adjustments made to reduce re-duplication (like 'reset') and to define Moodle core classes that can't be matched to bootstrap via a renderer

=== Javascripts ===
[http://jshirley.github.com/bootstrap/javascript.html YUI Bootstrap plugins] will be dropped in to the theme in place of the jQuery version(s).

=== Settings ===
On the roadmap: create a child theme (or themes) to provide end users with custom settings, possibly including:

* static or fixed navbar
* light or dark color
* 2 or 3 column layout
* custom logo
* [http://bootswatch.com/ bootswatches]

== Success criteria ==
To have developed a theme that can be used as a base theme, that looks and feels like the default bootsrap interface. (see: [http://twitter.github.com/bootstrap/getting-started.html#examples examples].

==Future developments ==

* To make a responsive version
* Create a library of custom renderers that can be used in themes to make UI changes
* Add theme settings that allow administrators to change the layout of templates through the theme interface.

== Potential projects ==

Some projects that don't require knowledge of PHP to help with:

=== Bootstrap for Educational Content ===

Take some of your existing content, or freely available courses and use Bootstrap styles to format it. Maybe write a document, that uses Bootstrap styles to explain how to apply Bootstrap styles to educational content. Look at the Bootstrap documentation for inspiration, it not only tells you what is possible, it demonstrates many of them in its own presentation:

* http://twitter.github.com/bootstrap/base-css.html#typography
* http://twitter.github.com/bootstrap/base-css.html#code
* http://twitter.github.com/bootstrap/base-css.html#tables
* http://twitter.github.com/bootstrap/base-css.html#images
* http://twitter.github.com/bootstrap/base-css.html#icons
* http://twitter.github.com/bootstrap/components.html#labels-badges
* http://twitter.github.com/bootstrap/components.html#typography
* http://twitter.github.com/bootstrap/components.html#thumbnails
* http://twitter.github.com/bootstrap/components.html#alerts
* http://twitter.github.com/bootstrap/components.html#misc

=== Bootstrap in Moodle content ===

There's plenty of places in Moodle that accept HTML and so can be spruced up with Bootstrap. For example, if you have a public access course, you could add a big green "start learning now" button with a white tick icon to the course description (or many other places on your site) just by using the following html:

<a href="#" class="btn btn-success btn-large"><i class="icon-white icon-ok"></i> Start Learning Now</a>

and the href is simply pointing to the course like any normal link, yet the presentation is transformed. There's probably a million other examples, try coming up with some and sharing them. For experimenting with what's possible with buttons, try: http://www.plugolabs.com/twitter-bootstrap-button-generator/

=== Bootstrap editor ===

Of course, to do the above currently takes HTML coding. But it would be nice if you could just press buttons on a gui. Moodle allows plugin editors, maybe we could use this: http://jhollingworth.github.com/bootstrap-wysihtml5/

=== Bootstrap for TinyMCE ===

The current editor is actually incredibly flexible. It is themeable (http://www.tinymce.com/wiki.php/Creating_a_theme) and Bootstrap comes with a range of editor icons. It should also be able to pick up and use classes from an editor.css file you feed it (http://www.tinymce.com/wiki.php/Configuration:content_css). It should be possible to create a better Bootstrap editor using this flexibility

=== Checkout the competition ===

There's all sorts of Bootstrap projects for various blog engines and content management systems. If you already use say Wordpress you could install some of them an report back anything useful, or just nice looking, that they do and you think would transfer across to Moodle. The new version of Joomla ([http://www.joomla.org/3/]) also uses Bootstrap throughout the user and admin interface and can probably provide some inspiration.

=== Create alternate icon sprites ===

All the Bootstrap icons are merged into one single image to make things download faster. If you want to use a different set of icons you'll need to do the same. Instructions here: http://favbulous.com/post/1006/create-custom-icons-for-twitter-bootstrap-easily

== Links to Discussions in Forums ==

* [http://moodle.org/mod/forum/discuss.php?d=212222 (re-)bootstrap: work in progress]
* [http://moodle.org/mod/forum/discuss.php?d=212341 Amelia and Cyborg Bootswatches for Moodle]
* [http://moodle.org/mod/forum/discuss.php?d=208162 Bootstrap for Moodle project]

== Resources ==

* [http://twitter.github.com/bootstrap/ Twitter Bootstrap Home]
* [http://jshirley.github.com/bootstrap/javascript.html Bootstrap YUI Plugins]
* [http://bootswatch.com/ Bootswatch]
* [http://bootsnipp.com/ Bootsnipp]
* [http://fortawesome.github.com/Font-Awesome/ Font Awesome] (icon font for Bootstrap)
* [http://www.alistapart.com/articles/building-twitter-bootstrap/ A List Apart: Building Twitter Bootstrap] (the story behind and philosophy of Bootstrap)
* [http://www.w3schools.com/bootstrap/bootstrap_popover.asp Bootstrap popover window] - The Popover plugin is similar to tooltips; it is a pop-up box that appears when the user clicks on an element. The difference is that the popover can contain much more content.

MySQL

2017-10-16T10:00:10Z

Demsley: /* Command line */

{{Installing Moodle}}
MySQL is one of the supported databases that underpins a Moodle installation.

== Installing MySQL ==

* If you are running Linux your preference should be to install using your distributions package manager. This ensures you will get any available updates. However, you can also use apt-get or yum depending on the distribution that you are running.
* There are installers available for most popular operating systems at http://www.mysql.com/downloads/mysql/.
* It is possible and reasonably straightforward to build mysql from source but it is not recommended (the pre-built binaries are supposedly better optimised).
* Make sure you set a password for the 'root' user (see http://dev.mysql.com/doc/refman/5.0/en/default-privileges.html).
* Consider installing and configuring my.cnf (the MySQL settings file) to suit your needs. The default configuration is usually very conservative in respect of memory usage versus performance. Increase the 'max_allowed_packet' setting to at least 4 megabytes. Also make sure that your collation and character set is using full UTF-8 support. Please view [[MySQL_full_unicode_support#Steps_to_upgrade]].
* If you are going to use Master/Slave replication, you must add binlog_format = 'ROW' into your my.cnf within [mysqld]. Otherwise, Moodle will not be able to write to the database.

== Creating Moodle database ==

These are the steps to create an empty Moodle database. Substitute your own database name, user name and password as appropriate.

The instructions assume that the web server and MySQL server are on the same machine. In this case the 'dbhost' is 'localhost'. If they are on different machines substitute the name of the web server for 'localhost' in the following instructions and the 'dbhost' setting will be the name of the database server.
Databases have a "Character set" and a "Collation". For Moodle, we recommend the Character Set be set to '''utf8mb4''' and the Collation '''utf8mb4_unicode_ci'''. You may get the option to set these values when you create the database. If you are not given a choice, the default options are probably good. An install on an old server may have the wrong settings.

=== Command line ===

* To create a database using the 'mysql' command line client, first log into MySQL
<pre>
$ mysql -u root -p
Enter password:
</pre>
(Enter the password you previously set - or been given - for the MySQL 'root' user). After some pre-amble this should take you to the ''mysql>'' prompt.
* Create a new database (called 'moodle' - substitute your own name if required). We recommend you use '''utf8mb4_unicode_ci''' for Collation.
<pre>
mysql> CREATE DATABASE moodle DEFAULT CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;
</pre>
* Add a user/password with the minimum needed permissions:
<pre>
mysql> GRANT SELECT,INSERT,UPDATE,DELETE,CREATE,CREATE TEMPORARY TABLES,DROP,INDEX,ALTER ON moodle.* TO moodleuser@localhost IDENTIFIED BY 'yourpassword';
</pre>
...which creates a user called 'moodleuser' with a password 'yourpassword'. Make sure you invent a strong password and resist the temptation to 'GRANT ALL'.
* Exit from mysql:
<pre>mysql> quit
</pre>

=== phpMyAdmin ===

[http://www.phpmyadmin.net/ phpMyAdmin] is a web based administration tool for MySQL. If this is available you can use it to create a new database. Make sure that you select 'UTF8' as the default character set.

==Which database belongs to which Moodle==
If you have installed several Moodle installations on the same server, there will be several databases in your MySQL server. The names might be quite poor reflections of the content like _mdl1 _mdl2 _mdl3 . So how do I see which database goes with which Moodle installation? You can go in with phpMyAdmin and in the various databases check for the table "mdl_course". There you will easily see the name of that Moodle Installation. In table mdl_config you can see the Moodle version. The main URL for the site is not in the database except where there are absolute links.

== See also ==

* [[MariaDB]]
* [[MySQL full unicode support]]
* [http://www.mysql.com/ The MySQL homepage]
* [http://en.wikipedia.org/wiki/MySQL Wikipedia article about ''MySQL'']
* [http://forums.mysql.com/read.php?24,92131,92131 List of articles on MySQL performance tuning]

[[Category:SQL databases]]

[[ja:MySQL]]
[[de:MySQL]]
[[es:MySQL]]

External database authentication

2017-10-12T13:09:20Z

Demsley:

{{Authentication}}
Location: '' Site administration > Plugins > Authentication > External database''

This method uses an external database table to check whether a given username and password is valid. If the user does not currently exist in Moodle a new account will be created and their information copied from the external database.

== Field mappings ==

This is done by mapping fields at the bottom of the database authentication page. Each data field in the user profile has a text field next to it. Enter the name of the column in the external database that maps to the profile data field.

'''Update Local''' - Specifies that the external data will be entered into the local field in question
* On Creation - specifies that this will only happen on the original login when the account is created for the first time.
* On Every Login - specifies that changes in the external data will be updated on the local Moodle field in question the next time the user logs in again.

'''Update External''' - Specifies just the opposite, meaning changes in the local Moodle field in question will update the corresponding field in the external database
* Never - Specifies this is disabled
* On Update - Enables this to happen if a change is made locally (additional configuration is probably required)

'''Lock Value''' - Only determines whether the local user can make a change in the Moodle field and does not affect the two settings above.
* Unlocked - A user can make changes locally in the Moodle field (assumably even if it contradicts the external database the next login would change it again if Update Local is set
* Locked - A user can never make changes
* Unlocked if empty - A user can only make changes if the field is not populated already from the external database (this would seem to indicate a user could only enter something into this field once and could not change it after saving)

== Automatic Synchronisation ==

The above method adds new users only when they log in. If you want user accounts to be created in Moodle independent of actual logins, the db authentication plugin offers a script you can run regularly via 'cron'. A typical cron entry will be as follows...

<pre>
0 * * * * /usr/bin/php /path/to/moodle/auth/db/cli/sync_users.php >dev/null
</pre>

This runs every hour (adjust as required). It reads the entire table updating and creating local Moodle users.

NB when you run this you get the error "[AUTH DB] The sync users cron has been depricated. Please use the scheduled task instead."
Information on scheduled tasks can be found here: [https://docs.moodle.org/35/en/Scheduled_tasks]

If you have custom profile fields on your site, these can be synced with External database authentication (syncing custom profile fields from the external database to Moodle does not currently work, see [https://tracker.moodle.org/browse/MDL-56093]).

==Additional Notes==

It is now possible to use Salted Crypt passwords for the password format with external database authentication from the Password format setting:
[[File:dbsaltedcrypt.png|thumb|300px|center]]

* Plain text password matching is now always case sensitive
* sha1/md5 hash comparisons are now enforced case insensitive (as underlying they are hexadecimal values)

* Some of the things that apply to [[Upload users]] apply to the External database, but not all of the fields in the [[Upload users]] are available for the External Database authentication. The only available fields are the fields listed in the data mapping section of the admin page for the External Database connection.
* Note that for MySQL databases moodle will store date custom profile fields in a bigint field (as a unix timestamp). Using a timestamp or datetime field will not work
==See also==
*Using Moodle [http://moodle.org/mod/forum/discuss.php?d=45444 Special and characters con tilde (accute accent) when connected to external database] forum discussion
*Using Moodle [http://moodle.org/mod/forum/discuss.php?d=75519 HELP!--User Authentication problem] forum discussion
*[[External database enrolment]]
*change password in external DB authentication plugin [https://moodle.org/mod/forum/discuss.php?d=269311#p1162046]

[[de:Externe Datenbank]]
[[fr:Authentification par base de données externe]]
[[ja:外部データベース認証]]
[[es:Autenticación con BasedeDatos externa]]

Apache

2016-08-18T08:49:02Z

Demsley: /* Slasharguments */

{{Installing Moodle}}
'''This article refers to the 'Apache HTTP server''''

The Apache HTTP server is the software that (along with the PHP scripting language) 'runs' Moodle. Note that there are alternatives (e.g. IIS on Windows) but the Apache HTTP Server is very popular on all platforms.

== Installing Apache ==
Installers are available for most platforms from http://httpd.apache.org/download.cgi. The official installation instructions are here: http://httpd.apache.org/docs/2.0/install.html. If you are running Linux then you are recommended to use the packaged version if you can. For example in Debian/Ubuntu it is simply:
<pre>
sudo apt-get install apache2
</pre>

See the documentation for your particular platform for the instructions. Apache is straightforward to build from source if you have to and the PHP documentation contains an article on building both Apache and PHP together - although you should rarely need to do that.

==Performance==

See [[Performance recommendations]]

==Slasharguments==

The function ''slash arguments'' is required for various features in Moodle to work correctly, as described in [[Using slash arguments]].

To turn it on, add this line to your ''httpd.conf'', or to a ''.htaccess'' file in your local directory:

AcceptPathInfo On

Note: When using ".htaccess" in your local Moodle install folder, you should include/enable "AllowOverride Directive" in "httpd.conf", first.
Also! please note that using .htaccess file will cause performance hit on your server!

If you are using 1and1 as a hosting company the above does not work. The solution is to create a php.ini file in the moodle directory with this content:

cgi.fix_pathinfo = 0

It was a know bug when using PHP as CGI.

==SSL==

Moodle has an option to enable HTTPS for the whole site or for just the login pages; either option requires that your web server is configured for SSL.

* Whole site HTTPS is enabled by changing http://<url> to https:// <url> in your config.php 'wwwroot' parameter.
* Login only HTTPS is enabled by setting the 'loginhttps' parameter, where the wwwroot schema should remain as http://

Login only https is available in the admin interface via Administration>Security>HTTP Security and checking the button. (Note the warning and see ssl section below)

Prior to Moodle 2.3 It was not advised to run the whole site over HTTPS due to legacy restrictions with client-side caching. This is no longer the case assuming client browsers support the 'Cache-Control: public' method, which all supported browsers for this version of Moodle do.

To use HTTPS you will need to obtain an SSL certificate, you have two options:

* Generate a self-signed certificate. This is fine on (say) an Intranet but unsuitable for the public internet, but users will we warned the certificated is untrusted when used publicly.
* Purchase a certificate from a vendor. There is a surprising range of prices and value-added services available. Some hosting companies even provide free certificates.

Debian provides instructions for installing a self-signed certificate [https://wiki.debian.org/Self-Signed_Certificate on their wiki] and includes general information on configuring Apache for SSL.
If you purchase a vendor certificate you will normally receive instructions for installing it.

A basic Apache SSL configuration can be summarised as:

Listen 443
NameVirtualHost *:443
<VirtualHost *:443>
SSLEngine On
SSLCertificateFile /path/to/your/certificate.crt
SSLCertificateKeyFile /path/to/your/certificate.key
...
</VirtualHost>

== See also ==

* [http://httpd.apache.org/ The Apache HTTP Server Project homepage]
* [http://en.wikipedia.org/wiki/Apache_HTTP_Server Wikipedia article on the Apache HTTP Server]
* [http://httpd.apache.org/docs/2.0/misc/perf-tuning.html Apache Performance Tuning article at the official homepage]
* [https://els.earlham.edu/cayaraa/weblog/1468.html Making Moodle work with SSL]
* [http://www.krufix.de/ Using the same Moodle twice in local network and Internet via SSL-Proxy] (in German)

[[pl:Apache]]
[[ja:Apache]]
[[de:Apache]]
[[es:Apache]]