2018-11-27T14:30:04Z

Jleyva: /* Troubleshooting */

{{OAuth2}}{{New features}}

== Nextcloud configuration ==

As a prerequisite, you need Nextcloud in version 14.0.4 (or above). Otherwise, please [https://docs.nextcloud.com/server/14/admin_manual/maintenance/upgrade.html upgrade to a recent Nextcloud version] first. Then you need to [https://docs.nextcloud.com/server/14/admin_manual/configuration_server/oauth2.html#add-an-oauth2-application register Moodle as an OAuth 2 client] as follows:

# Log in to Nextcloud using the administrator account.
# Open the menu in the top-right corner and select '''Settings'''. On the next page, select the '''Security''' item in the "Administration" section on the left. <br>[[File:nextcloud-oauth2-settings.png|100px]]
# At the top of the next page you see the list of registered clients (which is empty initially). Below "Add client", enter the name of your Moodle (e.g., "Mount Orange School Moodle") in the first field (Name). Note that the name that you enter here will be displayed to your Moodle users.
# In the second field (Redirection URI), enter the URL of your Moodle followed by '''/admin/oauth2callback.php''' (e.g., "<nowiki>https://school.demo.moodle.net/admin/oauth2callback.php</nowiki>").
# Click '''Add''' to save. Afterwards, the page looks similar to the screenshot below.

[[File:nextcloud-moodle-client.png|none|frame|Registration of Moodle as an OAuth 2 client in Nextcloud]]

Moodle is now allowed to connect to Nextcloud using OAuth 2 authentication.

== Moodle configuration ==

After you have [[#Nextcloud configuration|set up Nextcloud]], you can configure Moodle.

# Go to ''Site administration > Server > OAuth 2 services'' and click '''Create new Nextcloud service'''.
# On the next page, enter the '''Name''' of your Nextcloud, the '''Client ID''' and '''Client secret''' (as seen in the Nextcloud admin interface in the screenshot above) and the '''Service base URL''' which is the URL of your Nextcloud. If you use a custom Nextcloud '''Logo''', specify its URL, too.<br>[[File:nextcloud-issuer-settings.png|400px]]
# You do not need to change any other settings. Click '''Save changes'''.

Afterwards, you can use the Nextcloud service from your Moodle, for example from the [[Nextcloud repository]].

[[File:nextcloud-issuer-configured.png|none]]

== Troubleshooting ==

There are some configuration mistakes that might prevent Moodle from communicating with Nextcloud properly. Some of them are due to the fact that you can host Nextcloud on your own and that it is easy to make mistakes that are hard to spot at first. However, this list will help you resolve them.

; I cannot connect a system account. : Log out from Nextcloud first. Make sure the Nextcloud account that you want to connect as a system account is different from all personal accounts. It has to be an account that belongs to Moodle, not to a person. Also, check the issuer settings. The checkbox '''Authenticate token requests via HTTP headers''' must be enabled!
; Authentication seems to have succeeded, but the filepicker shows "There are no files". : It is possible that HTTPS is not configured correctly on the Nextcloud end. You need a ''valid'' and ''trusted'' certificate for your Nextcloud server! A self-signed certificate will not work. Unlike in the browser, you cannot manually "trust" a self-signed server certificate. You should also check that the Apache modules "rewrite", "headers" and "env" are installed and enabled in the Nextcloud server.
; After signing in with Nextcloud I get an error that says "This request is not valid. Please contact the administrator of [your Moodle Name] if this error persists.". : You might have entered the wrong ''Redirect URI'' in Nextcloud. It is important that it ends with '''/admin/oauth2callback.php''' and that it corresponds '''exactly''' to the URL that Moodle is going to send to Nextcloud when attempting to authenticate!
; When I access an access controlled link I authorise Moodle but then cannot see the file. : In older Nextcloud versions (prior to 14.0.1), when you authorise Moodle, your Nextcloud browser session ends. Upgrade to a recent Nextcloud version (see [[#Nextcloud configuration]]) to resolve this.
; Since I connected a system account, Moodle is very slow : Nextcloud has a brute-force protection that was somewhat naïve (prior to 14.0.3). When enabled, it slows down some Moodle requests in some cases (even though the Moodle plugin is definitely not going to brute-force your Nextcloud!). First, upgrade to a recent Nextcloud version (see [[#Nextcloud configuration]]) to resolve this. As an additional measure, you can download the [https://apps.nextcloud.com/apps/bruteforcesettings "Brute-force settings" app for Nextcloud]. After installation, add the IP of your Moodle server to the whitelist.
; When I try to create an access controlled link I get a "Cannot download this file" error. : This may happen if the system account is not connected. Go to ''Site administration > Server > OAuth 2 services'' and try to connect again the Nextcloud system account.

[[es:Servicio OAuth 2 Nextcloud]]

OAuth 2 Nextcloud service

Jleyva: /* Custom menu items */

{{Mobile}}
==Enable mobile services on your site==
Your site needs to have mobile access enabled so users can use the mobile app.

For sites using https, mobile access is enabled by default in new installations of Moodle 3.0 onwards.

For http sites, mobile access can be enabled by an administrator as follows:

# In ''Site administration > Mobile app > Mobile settings'' tick the 'Enable web services for mobile devices' checkbox
# Click the button to save changes.

If your site uses a [https://en.wikipedia.org/wiki/Transport_Layer_Security SSL certificate], it must be a trusted certificate. For security reasons the app doesn't work with self-signed certificates.

Please, verify that your certificate is valid via: https://www.geocerts.com/ssl_checker (you shouldn't see any warning).

If your site has the /login directory protected (frequently done when using the Shibboleth authentication method), you must enable access to the login/token.php script.

==Mobile authentication==

If your site uses a SSO authentication method (CAS, Shibboleth, LDAP SSO, OAuth...), then select via a browser window or via an embedded browser for 'Type of login' (typeoflogin) in 'Mobile authentication' in the Site administration. (This setting is provided for older pre-Moodle 3.2 sites via the [[Moodle Mobile additional features]] plugin.)

The options 'browser window' and 'embedded browser' are very similar; the only difference is when redirecting the user to enter their credentials in the site, the site will be opened in the device's default browser (for browser window) or the site will be opened "embedded" in the mobile app (for embedded browser). The user experience is better in embedded browser, but not all the authentication plugins will work in embedded browser (for example, if JavaScript popups are required they must use the 'browser window'). The admin should check whether both options work, and if so, choose 'embedded browser'.

If your organisation uses a custom branded app and 'Type of login' is set to 'Via a browser window' or 'Via embedded browser', then a URL scheme (forcedurlscheme) may be set. This will result in only the custom branded app working for the site: the official Moodle Mobile app will not work.

== Customise your app theme ==

The app can also retrieve your custom styles from your Moodle site. Since the app is a HTML5 app, you can safely apply any CSS, CSS2 and CSS3 style.

Go to ''Administration > Site administration > Mobile app > Mobile appearance'' and enter in the mobilecssurl field a valid URL pointing to a CSS file containing your custom styles.

The CSS should be placed inside your Moodle installation (in your custom theme or inside a local plugin).

'''For example:''' ''https://mymoodlesite.com/theme/mytheme/style/mymobileapp.css''

Once the user is logged in the app, remote CSS files for applying your custom styles are regularly retrieved.

Notice that on the first time a user opens the app, he will see the default "orange" style. Your custom styles will be applied once the user has added a site in the app.

For further information, see the dev docs [[:dev:Moodle Mobile Themes|Moodle Mobile Themes]].

If you want your own custom branding for your organization, Moodle offers the The Branded Moodle Mobile app service, please visit https://moodle.com/mobileapp/ for more information.

== Moodle Mobile additional features plugin for old Moodle sites ==

For old Moodle sites it is recommended to install the [[Moodle Mobile additional features]] plugin.

== Notifications ==

You might find them annoying but push notifications keeps you and your users informed and updated on everything about the app. Moodle only send useful and important notifications such as new features or service disruptions.

Enabling push notifications is easy! An administrator can enable it by connecting their Moodle site/s to our free Notifications server available (only) for registered Moodle sites.

An access key can be obtained via Administration > Site administration > Plugins > Message outputs > Mobile Notifications.

The full guide on enabling push notifications can be found here: [[Mobile app notifications]]

== App banners ==
[[File:app banner.png|thumb|Moodle Mobile app banner]]
App banners let your users know that there is a mobile app available for the site. App banners are only displayed when accessing the site using a mobile browser.

In Moodle 3.3 onwards, app banners for Android are supported as well as for iOS.

App banners are disabled by default. They can be enabled in 'Mobile appearance' in the Site administration.

If you are using a custom mobile app, you need to provide the unique identifier for the iOS and Android app; if you are using the Moodle Mobile app, the settings may be left as default.

=='Get the mobile app' link==

{{New features}}In Moodle 3.4 onwards, the link 'Get the mobile app' in the footer of each page on the site encourages users to make use of the mobile app.

By default, the link is https://download.moodle.org/mobile however the setting 'App download page' can be changed e.g. for sites using a branded mobile app.

If mobile services are not enabled for the site, then the 'Get the mobile app' link is not displayed.

To prevent the 'Get the mobile app' link being displayed, simply remove the URL from the 'App download page' setting and save changes.

== Configuring the app from your site ==

In Moodle 3.3 onwards, or with the [[Moodle Mobile additional features]] plugin, settings in the Site administration enable admins to configure the app.

* In Moodle 3.3 onwards go to ''Site administration > Mobile features''
* In sites with the Moodle Mobile additional features plugin installed, go to ''Site administration > Plugins > Local plugins > Mobile additional features''

===Force log out===

Replace the Change site option to "Log out" so that users must enter their credentials on their next access. This is useful for custom mobile apps, as there is no reason for users wanting to switch to a different site.

===Disabled features===

Disable app functionalities for your site. If there's a feature you don't want to make available via the app you can disable it here.

===Custom menu items===

Additional items can be added to the app main menu (the side menu), such as a link to a different grade book.

Each custom menu item should have format: item text, link URL, link-opening method and language code (optional, for displaying the item to users of the specified language only), separated by pipe characters.

Possible link-opening methods are:

* app - for linking to an activity supported by the app i.e. almost all activity types, as listed in [[Moodle Mobile features]].
* inappbrowser - for linking to external URLs or site functionalities not supported by the app. The link will open in a browser inside the app overlaying the complete screen.
* browser - as for inappbrowser except that the link will instead open in the device default browser outside the app.
* embedded - as for inappbrowser except that the link will instead open in an iframe in a new page in the app. (For this option you may need to enable the admin setting "Allow frame embedding" (allowframembedding)

Tip: If you add a custom menu item and save changes, then it doesn't appear in the app main menu, double check that the item is correctly formatted.

Please, note that if the app is using a language not indicated in the previous list, the first language in the list will be used.

If you want options tied to a language, you can append _only to the language code, for example:
en_only
es_only

Will display the custom menu item only when the app language is English or Spanish.

===Custom language strings ===

Words and phrases displayed in the app can be customised via the "Custom language strings" (customlangstrings) setting.

Enter each custom language string on a new line with format: string identifier, custom language string and language code, separated by pipe characters. For example:

mm.user.student|Learner|en
mm.user.student|Aprendiz|es

The complete list of string identifiers is listed in https://raw.githubusercontent.com/moodlehq/moodlemobile-phonegapbuild/master/build/lang/en.json. The string identifier is before the colon.

For example:

[[File:Mobile string identifiers list examples.png|300px]]

means that the string "Student" has string identifier "mm.user.student".

==Web services token duration==

{{New features}}In Moodle 3.4 onwards, an admin can set how long a web services token created by a user (for example via the mobile app) is valid. (In previous versions of Moodle a token was valid for 3 months.)

==See also==

* [[Moodle Mobile FAQ]] for other administration-related mobile app questions.
* [[:dev:Moodle Mobile debugging WS requests]] - a guide to helping you find and report problems with the Moodle Mobile app on your site
* [[:dev: Moodle Mobile Roadmap]]
* [[:dev:Moodle Mobile release notes]]
* [[:dev:Moodle Mobile|Moodle Mobile developer docs]]
* [[Moodle Mobile availability plugin]]
* [[Mobile web services]]

[[es:Moodle Mobile guía para administradores]]
[[de:Moodle Mobile - Anleitung für Administrator/innen]]

2017-12-13T13:28:55Z

Jleyva: /* For administrators */

Moodle app guide for admins

2017-11-30T18:15:44Z

Jleyva: /* Custom language strings */

Moodle app guide for admins

2017-11-22T11:12:12Z

Jleyva: /* Custom menu items */