.. include:: /shortcuts.rstext .. index:: pair: Administration; Extensions single: Site administrator; Extensions .. _extensions: Extensions ---------------- *Administration → Extensions* .. note:: *Extensions* is only accessible by site administrators. Extensions in Mahara serve to provide certain functionality in the system. Extensions can be installed at any point and can also be hidden. .. index:: pair: Extensions; Plugins single: Site administrator; Plugins .. _plugins: Plugin administration ~~~~~~~~~~~~~~~~~~~~~~~~~ *Administration → Extensions → Plugin administration* The *Plugin administration* lists all the plugins that are currently installed on your Mahara instance and provides a link to the plugin configuration settings where available. Plugins in Mahara are always installed and can be accessed if users know the URLs and would otherwise have access. Rather than enabling and disabling the functionality, plugins are hidden or made visible by clicking on the *hide* or *show* links beside the plugins. When hiding an artefact type plugin, Mahara stops the display of the blocks related to it. .. figure:: /images/administration/plugin_not_installed.* :alt: Warning when a plugin is not yet installed Warning when a plugin is not yet installed If you added a plugin to your site, you will need to go through its installation. A plugin that is not yet fully installed is marked with a warning. Click the *Install* link to start the installation process. In order to delete a plugin completely, you must delete the code and all database tables that pertain to the plugin. Additionally, you need to delete it from a number of system tables, e.g. "artefact", "artefact_config", "artefact_cron", etc. As an example, view the `information on how to uninstall the My Learning plugin `_. .. note:: Core Mahara functionality can be made unavailable to users by hiding it. This may be useful if you connect Mahara to another system that already provides this functionality or if you do not wish your users to use that functionality. However, the decision about hiding a functionality should be considered thoroughly as it may also mean that users may not be able to have as many artefacts available to them as they should have. In the following, only the plugins that have additional settings are discussed. .. index:: pair: Plugins - configurable; Folder single: New in Mahara 1.9; Default sort order of files in a folder block single: New in Mahara 1.9; Allow viewers to download files in a folder block .. _plugin_folderblock: |new in Mahara 1.9| Blocktype: File / folder ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ You can decide the default sort order for files displayed in a *Folder* block and whether viewers of portfolio pages that contain a *Folder* block should be able to download the contents of the folder as zip file in one go. .. figure:: /images/administration/plugin_file_folder.* :alt: Configure the Folder block Configure the *Folder* block #. **Default sort order of files**: Decide whether the default sort order for displaying files in a *Folder* block should be alphabetically ascending or descending. .. note:: Page authors can change the sort order for each block. #. **Download folders as zip files**: If you tick the checkbox, you can download the contents of a folder displayed in a *Folder* block as zip file. Thus, it is very easy for a viewer to grab all files at once and download them to their computer. .. seealso:: Site administrators decide in the :ref:`Artefact type: File settings ` for how long the zip file is kept on the server. .. index:: pair: Plugins - configurable; Image gallery single: Configuration of external image galleries .. _plugin_imagegallery: Blocktype: File / gallery ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ You can provide additional image gallery settings and also allow your users to make Flickr and Photobucket image galleries available. The settings you make on this page will be the default settings for all users. .. figure:: /images/administration/plugin_file_gallery.* :alt: Configure the Image gallery block Configure the *Image gallery* block #. **Use Slimbox2**: Check this box if you want to use this script to overlay images on the current page. #. **Use photo frame**: Check this box if you want to put a frame around the thumbnail of each photo in photo galleries. #. **Maximum photo width**: Set the maximum width (in pixel) to which the photos will be resized when viewed with Slimbox2. #. **Flickr API key**: If you want to allow users to display photos from Flickr, you need a valid Flickr API key. You can `apply for the key at Flickr `_. #. **Photobucket API key**: If you want to allow users to display photos from Photobucket, you need a valid API and private API key. You can get them from the developer page of `Photobucket `_. #. **Photobucket API private key**: Provide the private API key from Photobucket that you will have received. #. Click the *Save* button to keep your changes. .. index:: pair: Plugins - configurable; Embedded media single: Configurable default video size of "Embedded media" .. _plugin_internalmedia: Blocktype: File / internalmedia ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Configure which file types users can embed into the :ref:`Embedded media block `. If you disable a file type that has already been used in a block, it will not be rendered any more. Mahara comes with `Flowplayer `_, a media player that can play FLV, MP4 (in H.264 format) and MP3 files. Videos are embedded and audio files played with the help of this player. Other video file types can be enabled, but users must have the appropriate software installed on their computers and the respective plugin enabled in their browsers to play them. .. figure:: /images/administration/plugin_file_internalmedia.* :alt: Configure the Embedded media block Configure the *Embedded media* block #. Select the file types that you wish your users to be able to show on their portfolio pages. #. **Width**: Choose the default width (in pixels) for a video. #. **Height**: Choose the default height (in pixels) for a video. #. Click the *Save* button to keep your changes. .. note:: If you allow the embedding of file types that cannot be played by Flowplayer, some users may not have the necessary software installed for displaying these file types. .. index:: pair: Plugins - configurable; Wall .. _plugin_wall: Blocktype: Wall ^^^^^^^^^^^^^^^^^^^ You can limit the number of characters that are allowed for :ref:`wall ` posts in this configuration setting. Existing posts will not be changed. .. figure:: /images/administration/plugin_wall.* :alt: Configure wall settings Configure wall settings #. Choose the maximum number of characters for your wall posts. #. Click the *Save* button to keep your changes. .. index:: pair: Plugins - configurable; Comments .. _plugin_comments: Artefact type: Comments ^^^^^^^^^^^^^^^^^^^^^^^^^ Turn comment ratings on to enable 5-star ratings in the feedback section on artefacts and pages. .. note:: Ratings cannot be on their own and require either a comment or a file attachment. .. figure:: /images/administration/plugin_comment.* :alt: Enable comment ratings Enable comment ratings #. Click the checkbox to enable comment ratings. #. Click the *Save* button to keep your changes. .. index:: File upload agreement; Profile picture size; Default comment permissions pair: Plugins - configurable; File single: Update user file quota single: Institution file quota single: Group file quota single: Update group file quota single: Enable comments for audio and video files single: Allow institution administrators to set file quota single: Resize images on upload .. _plugin_file: .. _image_resizing: Artefact type: File ^^^^^^^^^^^^^^^^^^^^^^^^ You can configure a variety of options for uploading files. .. figure:: /images/administration/plugin_file.* :alt: Configure the file plugin Configure the file plugin #. **Default quota**: You can set the amount of disk space that **new users** will have as their quota. Existing user quotas will not be changed. #. **Update user quotas**: Check this box if you want to update the file quota for **existing users** with the value under **Default quota**. Only then will they be updated. #. **Institution quota**: Check this box if you want to allow institution administrators to set user file quotas and have default quotas for each institution. #. **Enforce a site-wide maximum quota**: Check this box if you do not wish an administrator to go beyond the allowed maximum quota. #. **Maximum quota**: You can set the maximum quota that an administrator can give to a user. Existing user quotas will not be affected. #. **Default group quota**: You can set the amount of disk space that **each group** will have as its quota. Existing groups will not be affected. #. **Update group quotas**: Check this box if you want to update the file quota for **existing groups** with the value under **Default quota**. Only then will they be updated. #. **Require agreement**: Enable this option if you want to force users to agree to certain terms before they can upload a file to the site. They must accept this agreement before they are able to choose a file from their computer to upload to Mahara. A default agreement is provided and the text displayed. #. **Use custom agreement**: If you want to write your own upload agreement, check this box in addition to **Require agreement**. #. **Custom agreement**: If you want to use a custom upload agreement, write it here. #. **Resize large images automatically**: Enable this option to resize any image that is uploaded to the maximum width and height settings. #. **User option**: Display users the option to resize images automatically in their :ref:`account settings `. #. **Maximum width and height**: Choose the maximum width and height (in pixels) to which images will be resized upon uploading. #. **Profile picture size**: Choose the maximum size of the profile pictures for users (in pixels). All images uploaded to the profile pictures area will be resized to these dimensions if they are larger. #. **Default comment permission**: Choose the artefact types which shall have comments enabled per default. Users can override these settings for individual artefacts in the :ref:`files area `. You can enable comments for: * archive, i.e. compressed file * audio file * file * folder * image * profile picture * video file #. **Select All** to mark all file types. #. **Select none** to clear your selections from the checkboxses. #. |new in Mahara 1.9| **Length of time to keep zip files**: :index:`Choose the amount of time ` for how long you want to keep the zip files on the server that are created during the folder download process. The default time frame is 3,600 seconds (1 hour). #. Click the *Save* button when you are finished making your changes. .. index:: pair: Plugins - configurable; Profile .. _plugin_profile: Artefact type: Profile ^^^^^^^^^^^^^^^^^^^^^^^^^^^ For profile information you can decide which fields a user must provide when a user account is created manually or via CSV file. These fields are marked **mandatory fields**. The profile fields marked **searchable fields** are available for all logged-in users to search on. .. figure:: /images/administration/plugin_profile.* :alt: Choose mandatory and searchable profile fields Choose mandatory and searchable profile fields #. **Mandatory fields**: Select the fields that you wish all users to fill in. Certain fields cannot be deselected. #. **Searchable fields**: Select the fields that can be searched on by others. Certain fields cannot be deselected. #. Click the *Save* button to keep your changes. .. index:: pair: Plugins - configurable; SAML .. _plugin_saml: Authentication: SAML ^^^^^^^^^^^^^^^^^^^^^^^^ If you wish to use :ref:`SAML authentication ` anywhere on your site, you must provide the path to your SAML php file in these settings. .. figure:: /images/administration/plugin_saml.* :alt: Prepare your site for SAML authentication Prepare your site for SAML authentication #. **SimpleSAMLphp lib directory**: Provide the fully qualified path to the library directory of SimpleSAMLphp, e.g. if the full path to the bootstrap autoload.php is ``/some_path_to/simplesamlphp_1_3/lib/_autoload.php`` then this value should be ``/some_path_to/simplesamlphp_1_3/`` #. **SimpleSAMLphp config directory**: Provide the fully qualified path to the configuration directory to be used for this Service Provider (SP) SimpleSAMLphp, e.g. if the full path to the config.php is ``/some_path_to/simplesamlphp_1_3/config/config.php`` then this value should be ``/some_path_to/simplesamlphp_1_3/config/`` #. Click the *Save* button to keep your changes. .. index:: pair: Plugins - configurable; Internal search single: Exact user search .. _plugin_search: Search: Internal search ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ If your site has a lot of users and uses a PostgreSQL database, user searches will be faster with exact user searching enabled. The setting will still work with MySQL databases, but it is unlikely that it increases search performance significantly. The advantage of the exact user search is that if you have 20 users with the first name "Percy" but different last names, you may find the user you are looking for more quickly because you can search for "Percy Pearle" and the result list will not show "Percy Pearl", "Percy Sutter", "Percy Townsend" etc. However, partial matches on profile fields will not return results, so if for example you have a user called "Percy", then typing "Perc" into the search box will not find that user anymore. .. figure:: /images/administration/plugin_search.* :alt: Configure the internal search plugin Configure the internal search plugin #. **Exact user searches**: Check this box if you want to enable exact user searches. #. Click the *Save* button to keep your changes. .. index:: pair: Plugins - configurable; Fulltext search single: Fulltext search .. _plugin_fulltext_search: Search: Elasticsearch ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ The regular Mahara search is limited to finding users and in certain places titles, descriptions and tags of pages or collections. However, Mahara can be extended to use allow for fulltext search capabilities. The Mahara core project team chose to use `Elasticsearch `_. This is a powerful and extensible fulltext search engine. It does require a Java server, e.g. Tomcat, to run and thus may not be available for small instances of Mahara. .. note:: Currently, the plugin can only be used for Mahara instances running on a PostgreSQL database. Work is in progress to extend the support for MySQL for Mahara 1.9. .. figure:: /images/administration/plugin_elasticsearch.* :alt: Configure the Elasticsearch plugin Configure the Elasticsearch plugin #. Most of the Elasticsearch configuration needs to be done on the server level. Here you only see the settings, but cannot change them directly. #. **Cron record limit**: Decide on the maximum number of records to be passed from the queue to the Elasticsearch server on each cron run. An empty field or ``0`` means that there is no limit. #. **Artefact types**: Check the artefact types that you want to include in the search index. Only artefact types that have a hierarchy defined below are valid. You will need to reset artefacts in the queue below for your changes to take effect. #. **Artefact types hierarchy**: Enter the hierarchy for each artefact type separated by ``|`` (a pipe). Place each artefact type on a row by itself. #. **Index reset**: View the number of records of each type currently in the queue to be sent to the Elasticsearch server. Items are sent to the Elasticsearch server each time the search plugin's cron task runs (every 5 minutes). #. Click the *Reset* button to clear the search index and thus deleting all records and requeuing them. #. Click the *Save* button to accept your changes. .. seealso:: You can find more information about `Elasticsearch in Mahara on the wiki `_. There are also some `developer notes `_ to get you started. .. index:: pair: Plugins - configurable; Forum .. _plugin_forum: Interaction: Forum ^^^^^^^^^^^^^^^^^^^^^^^^ The post delay setting determines the time (in minutes) that users have for editing their forum posts before they are mailed out. Once a forum post has been mailed and further edits are made, the date, time and editor are mentioned in the post. .. figure:: /images/administration/plugin_forum.* :alt: Set the edit time before the forum post is finalised Set the edit time before the forum post is finalised #. **Post delay**: Set the time in minutes before a post is finalised and further edits are marked as such. #. Click the *Save* button to keep your changes. .. index:: pair: Extensions; HTML filters single: Site administrator; HTML filters .. _html_filters: HTML filters ~~~~~~~~~~~~~~~~~~~ *Administration → Extensions → HTML filters* Mahara uses `HTML Purifier `_ to filter out malicious code that could threaten the security of the system. If you have code, e.g. iFrames or JavaScript that you wish to use and that otherwise gets filtered out, you will have to write a filter to circumvent that. Filters should always be specific to their purpose and not give 'carte blanche' to ensure security as much as possible. Mahara already comes with a number of installed filters. Others can be uploaded and then installed. If you have created a new set of HTML filters, you can install them by unzipping the files into the folder ``/htdocs/lib/htmlpurifiercustom`` and then click the *Install* button. Custom filters for iFrames that allow the embedding of media content such as YouTube and WikiEducator allow users to grab the URL of the page on which the media is displayed instead of having to find the actual embed code. .. note:: You do not necessarily require bespoke filters for media that you wish to embed via