Installing Joomdle in Moodle: Difference between revisions

From Joomdle
Jump to navigationJump to search
Created page with 'Installing Joomdle for Joomla! This document applies to Joomdle R0.23 The Joomdle for Joomla! extension consists of a Component, 5 Plugins and 2 Modules, refer to the end of thi…'
 
No edit summary
 
(27 intermediate revisions by the same user not shown)
Line 1: Line 1:
Installing Joomdle for Joomla!
{{Languages}}
This document applies to Joomdle R0.23


The Joomdle for Joomla! extension consists of a Component, 5 Plugins and 2 Modules, refer to the end of this article to see the full list.  To install Joomdle for Joomla!, use Joomla!'s Extension Manager and select the Joomdle package called "joomdle-joomla-package.zip".  The component, plugins and modules will all be installed as one package simplifying the installation for you.
{{Current Version}}


Note:  It also enables all the plugins and creates the modules although the are not published.
{{Installing Joomdle for Moodle}}


For additional information regarding the components, plugins and modules, refer to this document <insert doclink here>
==Configuring Joomdle for Moodle==


Once these files have been copied to the moodle/auth/joomdle directory, visit Administration Menu → Notifications to complete plugin installation.


Configuring Joomdle for Joomla
Then return to the  Moodle Network Authentication section found at  Administration Menu → Users → Authentication → Manage  authentication.  You should now see a new option Authentication Plugin called Joomdle, activate this plugin.


Joomdle Component
[[Image:r023_moodle_enable_joomdle_authentication_1.jpg|550px|moodle_auth_joomla1.jpg]]
Configuring Joomdle for Joomla! is done through the Joomdle Global Configuration screen which can be found by choosing the Parameters button in the Joomdle Component. There are five (5) section that you can configure, however, only the first is mandatory.


Then configure the plugin by clicking on the "Settings link" and enter your Joomla! server's domain name URL.  This is the only setting that needs to be configured.
Remember to add '''http://''' in front of your URL.


[[Image:r023_moodle_settings_joomdle_authentication_1.jpg|550px|moodle_auth_joomla.jpg]]


Section Description
There is also another option, that you may need to change: Connection method. It chooses which connection method to use when using Joomla's web services. Options are file_get_contents and curl. Select the one available in your server.
Section 1 Enter the path of your Moodle installation - this is likely to be http: //www.mydomain.com/moodle assuming you have installed Moodle in a directory called moodle off the Joomla! root.
* Tip: Leave it as default first, and then use System Check page in Joomdle component in Joomla to check which connection method is available in your server.
Auto create Moodle users.  Set this to "Yes" if you want Joomdle to automatically create new users in Moodle when they register in Joomla!.


Note: In current release, setting this option to No only makes sense when using Virtuemart integration, as there is no other method to create Moodle accounts.
To finish the Joomdle Moodle installation, go to Site Administration -> Notifications.


Section 2 The parameter tells Joomdle how to respond when you click on any of the Joomdle links.    This is a Global Joomdle setting and can be over written by setting the same parameters in the individual Joomdle Modules  and Joomdle Menu Views.
You have now configured the Moodle side of Joomdle.  Proceed to install and configure Joomdle for Joomla!
Open in the same window
Open in new window
Open in wrapper
Section 3 When you choose to open Moodle in a "Wrapper" you can choose the Wrapper dimensions.  This is a Global Joomdle setting and can be over written by setting the same parameters in the individual Joomdle Menu Views.
Wrapper scroll bars
Wrapper height
Wrapper width
Section 4 These options control which links should be displayed by default on course details view.
Section 5 Use these parameters if you wish to integrate Joomdle with VirtueMart (VM).
Virtuemart Category ID:  The Product Category ID that you wish Moodle Courses to appear under.


Subject of email: Enter the subject of the email sent when successfully purchasing a Moodle course.
There are other options you may wish to configure.


Body of email: Enter the body of the email sent when successfully purchasing a Moodle course.
[[File:moodle_js_options.png]]


For more detailed information regarding the Joomdle and VM integration refer to this page <insert doclink here>.
* Sync users to Joomla: Syncs user creation and removal, and user profile updating.
* Joomla default language: Joomla default languahe string. Only needed for J1.6/1.7 with multi language enabled
* Jomsocial activities: Add Jomsocial activities in response to Moodle events
* Create Jomsocial groups: Create a Jomsocial group for each course
* Delete Jomsocial groups: Delete Jomsocial group when deleting course
* Auto-sell courses: Create/update/delete courses on Joomla shop when done in Moodle
* Enrol parents in courses: Auto enrol parents in children courses
* Parent role ID: ID of parent role in Moodle


You can also modify the default options for User Profile data locking in Moodle. Locked fields cannot be edited by the user in Moodle, and take the value from Joomla.


Joomdle Plugins
{{Moodle lock user fields}}
The Joomdle plugins do not require any configuration. They are all enabled by default at install time.
{{End of Section}}


==Advanced Moodle Configuration (Optional)==


Joomdle Modules
<span class="alert">''Note:  Some of these options can render your Moodle site inaccessible - please ensure you know what you are doing! ''</span>
During installation of Joomdle for Joomla!, two new Modules will be installed: mod_joomdle_courses and mod_my_joomdle_courses.  These modules will automatically be installed and you are required to enable before they appear on your website.


In mod_joomdle_courses only, you can choose to diplay only courses available to guests.
====Removing the default Moodle login page (redirect the Moodle login page to Joomla!)====


* Define an alternate login URL for Moodle, so that Moodle users never see the Moodle login page.   We recommend that you don't enable this until everything is up, testing, testing again, tested one more time, and running.  Oh did we say, test first before you do this!
** Users->Authentication->Manage Authentication: Alternate Login URL.  Here we put Joomla URL.
* If you are using Moodle in a wrapper, you can use this URL, so Joomla login page won't appear inside the wrapper: <font color="#aa1428">http://yoursite.com/components/com_joomdle/views/wrapper/getout_login.php</font>


====Creating an alternative login page for Moodle's Administrators====


* If you have redirected the default Moodle login page to Joomla, as defined above, you will need to create an additional method to enter Moodle for Moodle Administrators.  To access Moodle, enter this URL in your browsers address bar <font color="#aa1428">http://yoursite.com/moodle/auth/joomdle/joomdle_login.php?login=moodle</font>


Package Components
====Restrict access to Moodle to registered users only====
The Joomdle for Joomla! package consists of the following:


Component: com_joomla
* Restrict access to Moodle to registered users only, so that no guests can enter the Moodle site.
 
** Security -> Site Policies -> Force users to login
5 Plugins:
 
plg_joomdle
plg_joomdlehooks
plg_search_courses
plg_search_coursetopics
plg_search_coursecategories
2 Modules:
 
mod_joomdle_courses
mod_joomdle_my_courses

Latest revision as of 17:06, 18 December 2011

This document applies to Joomdle Release 2.0.0

Installing Joomdle for Moodle

To allow Moodle to authenticate with Joomla! you will need to install and configure the Joomdle authentication plugin.  This plugin can be found in the Joomdle installation package called auth_joomdle.zip (folder moodle/).

You can directly upload the plugin through Moodle interface, in Site administration->Plugins->Install add-ons


.

Configuring Joomdle for Moodle

Once these files have been copied to the moodle/auth/joomdle directory, visit Administration Menu → Notifications to complete plugin installation.

Then return to the  Moodle Network Authentication section found at  Administration Menu → Users → Authentication → Manage  authentication.  You should now see a new option Authentication Plugin called Joomdle, activate this plugin.

moodle_auth_joomla1.jpg

Then configure the plugin by clicking on the "Settings link" and enter your Joomla! server's domain name URL.  This is the only setting that needs to be configured. Remember to add http:// in front of your URL.

moodle_auth_joomla.jpg

There is also another option, that you may need to change: Connection method. It chooses which connection method to use when using Joomla's web services. Options are file_get_contents and curl. Select the one available in your server.

  • Tip: Leave it as default first, and then use System Check page in Joomdle component in Joomla to check which connection method is available in your server.

To finish the Joomdle Moodle installation, go to Site Administration -> Notifications.

You have now configured the Moodle side of Joomdle.  Proceed to install and configure Joomdle for Joomla!

There are other options you may wish to configure.

File:Moodle js options.png

  • Sync users to Joomla: Syncs user creation and removal, and user profile updating.
  • Joomla default language: Joomla default languahe string. Only needed for J1.6/1.7 with multi language enabled
  • Jomsocial activities: Add Jomsocial activities in response to Moodle events
  • Create Jomsocial groups: Create a Jomsocial group for each course
  • Delete Jomsocial groups: Delete Jomsocial group when deleting course
  • Auto-sell courses: Create/update/delete courses on Joomla shop when done in Moodle
  • Enrol parents in courses: Auto enrol parents in children courses
  • Parent role ID: ID of parent role in Moodle

You can also modify the default options for User Profile data locking in Moodle. Locked fields cannot be edited by the user in Moodle, and take the value from Joomla.


File:Lock user fields.png


.

Advanced Moodle Configuration (Optional)

Note:  Some of these options can render your Moodle site inaccessible - please ensure you know what you are doing!

Removing the default Moodle login page (redirect the Moodle login page to Joomla!)

  • Define an alternate login URL for Moodle, so that Moodle users never see the Moodle login page.   We recommend that you don't enable this until everything is up, testing, testing again, tested one more time, and running.  Oh did we say, test first before you do this!
    • Users->Authentication->Manage Authentication: Alternate Login URL.  Here we put Joomla URL.
  • If you are using Moodle in a wrapper, you can use this URL, so Joomla login page won't appear inside the wrapper: http://yoursite.com/components/com_joomdle/views/wrapper/getout_login.php

Creating an alternative login page for Moodle's Administrators

Restrict access to Moodle to registered users only

  • Restrict access to Moodle to registered users only, so that no guests can enter the Moodle site.
    • Security -> Site Policies -> Force users to login