11.8. Erweiterungen

Administration menu → Extensions

Bemerkung

Erweiterungen ist nur für Site-Administratoren verfügbar.

Erweiterungen stellen zusätzliche Funktionen in Ihrem System zur Verfügung. Sie können jederzeit installiert und wieder deaktiviert werden.

11.8.1. Verwaltung der Erweiterungen

Administration menu → Extensions → Plugin administration

Die Plugin-Verwaltung listet alle derzeit installierten Erweiterungen Ihrer Mahara-Installation auf und bietet Ihnen Zugriff auf die Konfigurationseinstellungen, sofern diese vorgesehen sind.

Plugins in Mahara are always installed and can be accessed if people 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 buttons beside the plugins. When hiding an artefact type plugin, Mahara stops the display of the blocks related to it as well.

Warnung wenn ein Plugin noch nicht installiert wurde

Warnung wenn ein Plugin noch nicht installiert wurde

If you added a plugin to your site’s codebase or if a new plugin was added to Mahara since the last upgrade that you performed, you will need to install it. A plugin that is not yet fully installed is marked with a warning and listed first in its section. 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.

Bemerkung

Core Mahara functionality can be made unavailable to account holders 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 people to use that functionality. However, the decision about hiding a functionality should be considered thoroughly as it may also mean that people may not be able to have as many artefacts available to them as they could have.

If a particular default plugin has been deprecated, an alert is displayed on an upgraded site to alert the site administrator to that change.

Alert when a plugin has been deprecated

Alert when a plugin has been deprecated

Im Folgenden werden nur die Artefakte erörtert, die weitere Einstellfunktionen aufweisen.

11.8.1.1. Blocktype

You can decide in which order the block types are listed in the block configuration when you put a block onto a page.

Order the block types for display in the placeholder block configuration

Order the block types for display in the placeholder block configuration

  1. All block types that are available in Mahara are listed. You may not put all onto every page as their usage depends on the page context. Drag and drop the blocks to change their order.

    Bemerkung

    Typically, the first four blocks are displayed in the placeholder block configuration by default. Other blocks are accessible by clicking the Show more button.

    This allows you to give quick access to the four most widely used blocks. Alternatively, you could pull blocks higher up that are underused.

  2. The number indicates how many times this block has been used on the site.

    Bemerkung

    Some blocks are automatically placed on all profile and dashboard pages or group homepages.

11.8.1.2. Blocktyp: Datei / Verzeichnis

Sie können die Standardsortierfolge für Dateien festlegen, die in einem Verzeichnis-Block angezeigt werden, und die Funktion zum Download der Dateien für Betrachter eines Portfolios in gezippter Form aktivieren.

Configure the Folder block

Konfigurieren Sie den Ordner-Block

  1. Standardsortierfolge für Dateien: Legen Sie fest, ob die Reihenfolge der Anzeige von Dateien in einem Verzeichnis-Block alphabetisch auf- oder absteigend sein soll.

    Bemerkung

    Autoren von Ansichten können die Reihenfolge für jeden Block festlegen.

  2. Download folders as zip files: Switching this option to ‚Yes‘, you can download the contents of a folder displayed in a Folder block as zip file.

    Siehe auch

    Site administrators decide in the Artefact type: File settings for how long the zip file is kept on the server.

11.8.1.4. Blockytp: Datei /interne Medien

Configure which file types people can embed into the 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 Video.js, a media player that can play a number of media files and does not require Flash (though it does have a Flash fallback option). Other video file types can be enabled, but people must have the appropriate software installed on their computers and the respective plugins enabled in their browsers to play them.

Configure the Embedded media block

Konfigurieren Sie den Eingebettete Medien-Block

  1. Turn on the file types that you wish authors to be able to show on their portfolio pages.

  2. Klicken Sie Speichern, um Ihre Änderungen zu speichern.

Bemerkung

If you allow the embedding of file types that cannot be played by Video.js, some people may not have the necessary software installed for displaying these file types.

Here’s an overview of the video and audio file formats that can be played by Video.js and which browsers can view them. Only because Video.js supports them does not mean that all browsers can play them. They still need to support a specific file format themselves. Listed are only the browsers that Mahara supports. For updates to browser support, check the site ‚Can I use…‘.

iOS devices may not always display MP4 files as the devices may only recognize the MPEG4 ‚Baseline‘ profile rather than the ‚High‘ profile. You can read the Apple specifications and convert a video if needed using Handbrake. Newer iOS devices (from the iPhone 5S on) should play ‚High‘ profile videos.

File format

Chrome

Chrome for Android

Firefox

Internet Explorer / Edge

Opera

Safari (incl. iOS)

3GPP media file

FLV Flash movie (requires Flash)

M4A movie

MP3 audio

MP4 video (H.264)

MPEG movie

OGA audio

OGG Vorbis audio file

OGV video

WAV audio

(Edge)

WEBM video file

Bemerkung

While you can upload any file fromat from any computer or Android device, you are not able to upload audio files from an iOS device. You can only upload MOV video files. These require a browser plugin to be played and are not served via Video.js.

AVI and WMV files can only be played on computers running Windows unless you have a browser plugin installed on another operating system.

11.8.1.5. Blocktyp: Text

Sie können den Notizen Blocktyp in Text Blocktypen für die gesamte Instanz umwandeln.

Text-Einstellungen konfigurieren

Text-Einstellungen konfigurieren

  1. Mahara errechnet wie viele Notizen konvertiert werden können. Notizen mit folgender Eigenschaft werden in die Konvertierung einbezogen:

    • wurde in keinem anderen Block wiederverwendet;

    • es wurde keine Lizenz hinzugefügt;

    • verwendet keine Schlagworte;

    • hat keine Dateianhänge;

    • have not received any comments.

  2. Turn on the option Convert ‚Note‘ blocks to convert all notes.

  3. Klicken Sie auf den Speichern-Button, um die Konvertierung zu starten. Dieser Vorgang kann bei einer großen Anzahl von Blöcken einige Zeit in Anspruch nehmen.

Siehe auch

If you have a large site, the conversion of notes to text may take a very long time. It can be beneficial to use the command-line script.

11.8.1.6. Blocktyp: Pinnwand

Sie können an dieser Stelle die Länge von Beiträgen auf der Pinnwand festlegen. Der Wert wird als Länge in eingegebenen Zeichen angegeben. Bei einer nachträglichen Änderung hat dies auf bestehende Einträge keinen Einfluß.

Pinwandeinstellungen konfigurieren

Pinwandeinstellungen konfigurieren

  1. Legen Sie die Höchstzahl von Zeichen für Pinnwandeinträge fest.

  2. Klicken Sie Speichern, um Ihre Änderungen zu speichern.

11.8.1.7. Blocktype: Watchlist

Bemerkung

new in Mahara 21.04 This setting moved to the Plugin administration from the Site options where it could be found prior to Mahara 21.04.

Sie können an dieser Stelle die Länge von Beiträgen auf der Pinnwand festlegen. Der Wert wird als Länge in eingegebenen Zeichen angegeben. Bei einer nachträglichen Änderung hat dies auf bestehende Einträge keinen Einfluß.

Configure the watchlist settings

Configure the watchlist settings

  1. Watchlist notification delay: This is the delay in minutes until watchlist notifications are sent. This prevents that too many notifications are sent when lots of changes are made within a short time frame. Default setting: 20.

  2. Klicken Sie Speichern, um Ihre Änderungen zu speichern.

11.8.1.8. Artefakttyp: Kommentare

Turn comment ratings on to enable ratings in the comment section on artefacts and pages. You can change the look of the comment ratings as well as the scale.

Bemerkung

Ratings cannot be on their own. They require either a comment or a file attachment.

Die Funktion Kommentarbewertungen einschalten

Die Funktion Kommentarbewertungen einschalten

  1. Enable comment ratings: Switch to ‚Yes‘ to enable comment ratings.

  2. Icon to use to display ratings: Use the drop-down menu to select the icon that you want to use for your ratings. You can choose between:

    • Star

    • Heart

    • Thumbs up

    • Tick

  3. Number of rating choices: Choose the scale that people will see when rating comments.

    Bemerkung

    If you change the number of rating choices, the ratings themselves will not be recalculated to fit that new scale.

  4. Colour: Use the colour picker to select the colour for your icon or enter the hexadecimal color code.

  5. Generated example: See a preview of what your comment ratings will look like.

  6. Klicken Sie Speichern, um Ihre Änderungen zu speichern.

11.8.1.9. Artefakttyp: Datei

Sie können verschiedene Optionen für den Dateiupload einstellen:

  • Default account quota

  • Gruppen-Standardkontingent

  • Zustimmungserklärung zum Hochladen

  • Größe der Bilder beim Upload anpassen

  • Profilbildgröße

  • Kommentare

  • Ordnerdownload

11.8.1.9.1. Default account quota

Configure the default account quota

Configure the default account quota

  1. Default quota: You can set the amount of disk space that new accounts will have as their quota. Existing account quotas will not be changed.

  2. Update account quotas: Switch this option to ‚Yes‘ if you want to update the file quota for existing accounts with the value under Default quota. Only then will they be updated.

  3. Enforce a sitewide maximum quota: Switch to ‚Yes‘ if you do not want an administrator to allocate more space than the Maximum quota.

  4. Maximum quota: You can set the maximum quota that an administrator can give to an account holder. Existing account quotas will not be affected.

  5. Quota notification threshold: Set a percentage for when an account holder receives a notification about reaching the upload limit for files. They can then decide to delete files to free up space or contact their site or institution administrator to request more space.

  6. Site administrator notification: Switch to ‚Yes‘ if the site administrator shall receive the quota notification emails to take action.

  7. Institutional override: Switch this option to ‚Yes‘ if you want to allow institution administrators to set account file quotas and have default quotas for each institution.

  8. Klicken Sie auf den Speichern-Button am Fuß der Seite wenn Sie mit Ihren Änderungen fertig sind oder wechseln Sie zum nächsten Abschnitt auf der Seite.

11.8.1.9.2. Gruppen-Standardkontingent

Konfigurieren des Standardwerts für die Dateiablage von Gruppen

Konfigurieren des Standardwerts für die Dateiablage von Gruppen

  1. Standard-Gruppenkontingent: Setzen Sie Dateiablagekontingent für jede Gruppe. Bestehende Gruppen werden davon nicht beroffen.

  2. Update group quotas: Switch to ‚Yes‘ if you want to update the file quota for existing groups with the value under Default quota. Only then will they be updated.

  3. Klicken Sie auf den Speichern-Button am Fuß der Seite wenn Sie mit Ihren Änderungen fertig sind oder wechseln Sie zum nächsten Abschnitt auf der Seite.

11.8.1.9.3. Zustimmungserklärung zum Hochladen

Die Zustimmung bei der Dateiablage konfigurieren

Die Zustimmung bei der Dateiablage konfigurieren

  1. Require agreement: Switch to ‚Yes‘ if you want to force people 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.

  2. Standard-Zustimmung: Dies ist die Standarddarstellung einer Zustimmung, die dem Nutzer angezeigt wird wenn die Erklärung verpflichtend ist und keine Anpassung vorgenommen wird.

  3. Use custom agreement: If you want to write your own upload agreement, switch this option to ‚Yes‘ in addition to Require agreement.

  4. Eigene Zustimmungserklärung: Tragen Sie hier Ihren eigenen Text für eine Zustimmungserklärung ein.

  5. Klicken Sie auf den Speichern-Button am Fuß der Seite wenn Sie mit Ihren Änderungen fertig sind oder wechseln Sie zum nächsten Abschnitt auf der Seite.

11.8.1.9.4. Größe der Bilder beim Upload anpassen

Konfiguration der Bildgrößenanpassung.

Konfiguration der Bildgrößenanpassung.

  1. Resize large images automatically: Switch this option to ‚Yes‘ to resize any image that is uploaded to the maximum width and height settings.

  2. Personal option: Switch to ‚Yes‘ if you want to display the option to resize images automatically in the account settings.

  3. Maximale Breite: Legen Sie die Höchstbreite (in Pixeln) fest. Größere Bilder werden auf diese Größe angepasst.

  4. Maximale Höhe: Legen Sie die größte Höhe (in Pixeln) fest. Größere Bilder werden auf diese Größe angepasst.

  5. Klicken Sie auf den Speichern-Button am Fuß der Seite wenn Sie mit Ihren Änderungen fertig sind oder wechseln Sie zum nächsten Abschnitt auf der Seite.

11.8.1.9.5. Profilbildgröße

Konfigurieren der Größe vonProfilbildern

Konfigurieren der Größe vonProfilbildern

  1. Width: Choose the maximum width (in pixels) of the profile pictures.

  2. Height: Choose the maximum height (in pixels) of the profile pictures.

  3. Klicken Sie auf den Speichern-Button am Fuß der Seite wenn Sie mit Ihren Änderungen fertig sind oder wechseln Sie zum nächsten Abschnitt auf der Seite.

Bemerkung

Alle Bilder, die zum Profilbereich des Nutzers hochgeladen werden, werden an diese Dimensionen angepasst wenn sie größer sind.

11.8.1.9.6. Kommentare

Konfigurieren der Standard-Kommentareinstellungen für verschieden eDateitypen

Konfigurieren der Standard-Kommentareinstellungen für verschieden eDateitypen

  1. Click the Select All button to mark all file types.

  2. Click the Select none button to clear your selections of the check boxes.

  3. Default comment permission: Choose the artefact types which shall have comments enabled per default. Authors can override these settings for individual artefacts in the files area. You can enable comments for:

    • Archive; z.B.: komprimierte Dateien (zip)

    • Audio-Dateien

    • Dateien

    • Verzeichnisse

    • Bilder

    • Profilbilder

    • Video-Dateien

  4. Klicken Sie auf den Speichern-Button am Fuß der Seite wenn Sie mit Ihren Änderungen fertig sind oder wechseln Sie zum nächsten Abschnitt auf der Seite.

11.8.1.9.7. Ordnerdownload

Konfigurieren der Verzeichnis-Download Einstellungen

Konfigurieren der Verzeichnis-Download Einstellungen

  1. Zeitdauer der Speicherung für Zip-Dateien: Beim Verzeichnis-Download werden Zip-Dateien erstellt. Mit dieser Einstellung legen sie fest wie lange diese Zip-Dateien auf dem Server zum Download bereitgehalten werden. Der Standardwert ist 3.600 Sekunden (1 Stunde).

  2. Klicken Sie auf ‚Speichern‘, um die Änderungen zu sichern.

11.8.1.10. Artefact type: Internal - Profile

For profile information you can decide which fields someone must provide and which fields you can search on in the administration and elsewhere on the site.

Siehe auch

Add custom profile fields more via an addition to a local file in the Mahara code base.

Pflichtfelder und durchsuchbare Profilfelder festlegen

Pflichtfelder und durchsuchbare Profilfelder festlegen

  1. Mandatory fields: Select the fields that you wish everyone to fill in. Certain fields cannot be deselected.

    Bemerkung

    At the moment, you cannot unselect ‚Last name‘ because it is needed when you use SAML for SSO purposes. If you do not use SAML and want to make the last name optional, you can change the code to accommodate your choice.

  2. Durchsuchbare Felder: Wählen Sie die Felder, die von anderen zur Suche genutzt werden können. Einige Felder können nicht abgewählt werden.

  3. Administration people search: Select the fields that you want to display in the People search table. The fields you select here are not exported to the CSV file though.

  4. new in Mahara 21.04 Default comment permissions: You can decide which artefacts shall have comments enabled per default. Currently, only ‚Notes‘ are available. The default comment permissions for files are set in the plugin settings for files.

    Bemerkung

    Use the Select all and Select none buttons to select all profile fields at once or to clear your selection respectively.

  5. Klicken Sie auf den Speichern-Button, um Ihre Änderungen zu bestätigen.

11.8.1.11. Authentifizierung: SAML

If you wish to use SAML authentication anywhere on your site, you can find all necessary information on your site’s metadata and certificate here.

Bemerkung

SimpleSAMLphp is a managed dependency that is included in Mahara, which makes the installation of SAML-based authentication methods easier.

You may need to install a few more dependencies manually. Please follow the on-screen instructions if that were the case.

Site für SAML Authentifizierung vorbereiten

Site für SAML Authentifizierung vorbereiten

  1. Service Provider entityId: This is the unique ID that identifies your Mahara instance to the Identity Provider, e.g. example.org/mahara. It is filled in automatically with the wwwroot of your instance. If it is incorrect, you can change it here.

  2. Service Provider metadata: The metadata link takes you to the page with your SAML metadata that you would need to give to the Identity Provider.

  3. Signature algorithm: This is the algorithm that will be used to sign SAML requests. This makes it possible to use the SAML authentication with ADFS (Active Directory Federation Services). The following options are available:

    • SHA256 (Default)

    • SHA384

    • SHA512

    • Legacy SHA1 (Dangerous)

    Warnung

    The SHA1 algorithm is only provided for backwards compatibility. Unless you absolutely must use it, it is recommended to avoid it and use at least SHA256 instead.

  4. Private key passphrase: For added security, enter a passphrase to protect the private key.

    Bemerkung

    This passphrase now allows you to change your site name without that impacting the SAML certificate.

  5. New private key passphrase: If you want to change the private key passphrase, you can do so here.

  6. Public key: The public key is generated and rotated automatically. Typically, you would not need to copy it from here since you copy the entire metadata. It is displayed for verification purposes.

  7. Click the Create new key / certificate button if you want to force the creation of a new public key.

  8. Click the Save button to make your changes.

When you create a new key, the old certificate can still be used for an interim period of time until you delete it. This allows for a transition period until all IdPs use the new certificate.

Rotate the SAML public key

Rotate the SAML public key

  1. Old SAML Service Provider signing and encryption certificate: The old certificate details are displayed and can be used until the certificate expires.

  2. New SAML Service Provider signing and encryption certificate: The new certificate details are displayed and can be used immediately.

  3. Click the Delete old certificate button to remove the old certificate when you are certain that no IdP is using it any more.

  4. Click the Save button to make your changes.

You can view all Identity Providers that are set up on Mahara and delete them if needed.

List all IdPs set up on the site

List all IdPs set up on the site

  1. Identity Provider entity: Title of the Identity Provider’s authentication.

  2. Provider: Name of the Identity Provider.

  3. Institutions: Institution or institutions that use this IdP. The link takes you to the institution’s contacts page.

  4. Delete IdP: Click the Delete button to remove the IdP that should not be used any more on the site. You see the button only for IdPs that are not used in any institution.

11.8.1.12. Suche: Elasticsearch

The regular Mahara search is limited to finding accounts and in certain places titles, descriptions, and tags of pages or collections. However, Mahara can be extended with full text search capabilities via Elasticsearch. Elasticsearch is is a powerful and extensible full text search engine that is also used for the learning analytics reporting in Mahara. It does require a Java server, e.g. Tomcat, to run.

Bemerkung

If you are upgrading from a version of Mahara prior to Mahara 17.10 and you already had Elasticsearch in use, please take a look at the upgrade instructions. That documentation also provides information on how you can set up Elasticsearch on a computer for development purposes.

Konfigurieren des Elastic-Search-Plugins

Konfigurieren des Elastic-Search-Plugins

The majority of the Elasticsearch configuration must be done on the server. This page displays that information, but does not allow you to set many configuration values.

  1. At the top of the screen you see the overall status of Elasticsearch.

  2. Host: The hostname of the Elasticsea`rch server. The default is 127.0.0.1.

  3. Elasticsearch port: The port used by Elasticsearch. The default is 9200.

  4. Scheme: Whether to use http or https. Preferred is https for added security.

  5. Authentication username: The username required for the specific Elasticsearch index for this site to access information. This value is optional. It is only required when you have multiple sites accessing one Elasticsearch cluster.

  6. Authentication password: The password used to secure the ‚Authentication username‘. This value is optional.

  7. Authentication write username: The username for writing to the search index. This field is optional.

  8. Authentication write password: The password used to secure the ‚Authentication write username‘. This value is optional.

  9. Index name: The name of the search index. The default is ‚mahara‘.

  10. Bypass index: This index can be used to load data in instead of the main one. this value is optional.

  11. Elasticsearch analyzer: The analyzer class. The default is ‚mahara_analyzer‘.

  12. Elasticsearch types: A comma-separated list of all the elements that Elasticsearch indexes. The default values are usr, interaction_instance, interaction_forum_post, group, view, artefact.

  13. Datensatzverabeitung durch Cron (Limit): Legen Sie fest wie viele Datensätze von der Warteliste auf dem Elasticsearch Server bei jedem Cron-Aufruf bearbeitet werden sollen. Ein leeres Feld oder ‚0‘ bedeutet, dass kein Limit gesetzt wird.

    Bemerkung

    If you use Elasticsearch for development purposes on a computer, choose a small number, e.g. 1,500.

  14. Shards: The number of pieces that the index makes. The default is 5.

  15. Replica shards: The number of copies of the shards. If you only have one node, set this value to 0, e.g. when you run Elasticsearch on a development computer connecting to a local Elasticsearch setup.

  16. Artefact types: 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.

  17. Click the Select all or Select none buttons if you want to change your mind about the current selection quickly.

  18. Select individual artefact types that you want to include into or exclude from the indexing.

  19. Artefact types hierarchy: Enter the hierarchy for each artefact type that you selected separated by | (a pipe). Place each artefact type on a row by itself.

Bemerkung

The first item is the artefact type, the second item is the category to which it belongs. This is an additional filter option. The third item is the main type, i.e. the tabs on the search result page.

  1. Index zurücksetzen: Zeigt die Anzahl der Datensätze für jeden Artefakttyp in der Warteliste für die Indizierung auf dem Elasticsearch Server. Mit jedem Cron Job (alle fünf Minuten) werden neue Datensätze verarbeitet.

  2. Each type is listed with the number of records not yet processed.

  3. Reset ALL indexes: Click the Reset button to clear the search index and thus deleting all records and requeuing them. This also saves any changes you made on this page.

  4. Klicken Sie auf den Speichern-Button, um Ihre Änderungen zu bestätigen.

Siehe auch

You can find more information about Elasticsearch in Mahara on the wiki. There are also some developer notes to get you started.

11.8.1.14. Interaktion: Forum

The post delay setting determines the time (in minutes) that group members 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.

Legen Sie die Bearbeitungsdauer für einen Forenbeitrag fest

Legen Sie die Bearbeitungsdauer für einen Forenbeitrag fest

  1. Beitragsverzögerung: Zeit in Minuten nach dem ein Beitrag als abgeschlossen angesehen wird und jede Änderung gekennzeichnet wird.

  2. Klicken Sie Speichern, um Ihre Änderungen zu speichern.

11.8.1.15. Module: LTI

You can activate the LTI API in order to use the LTI integration.

Configure the LTI plugin

Configure the LTI plugin

  1. The message lets you know whether the LTI functionality is enabled or not.

  2. Configuration item: List of the configuration items for LTI.

  3. Status: Displays which configuration items are ready to be used and which ones are not.

  4. Auto-configure LTI: Switch to Yes if you want all settings to be made automatically.

    Bemerkung

    Once the auto-configuration was successful, you do not see this option any more. You can bring it back by making a change in the Web services section manually.

  5. Click the Save button to save your changes.

11.8.1.16. Module: Mobile API

You can activate the mobile API in order to use ‚Mahara Mobile‘, the new Mahara app.

Configure the mobile API

Configure the mobile API

  1. The message lets you know whether the mobile apps API is enabled or not.

  2. Configuration item: List of the configuration items for the mobile apps API.

  3. Status: Displays which configuration items are ready to be used and which ones are not.

  4. Auto-configure mobile apps API? Switch to Yes if you want all settings to be made automatically.

    Bemerkung

    Once the auto-configuration was successful, you do not see this option any more. You can bring it back by making a change in the Web services section manually.

  5. Manual token generation: Switch to Yes if you want to allow your people to create the initial app token manually. This is only needed if the authentication method does not support the token generation. This is the case with MNet for example.

  6. Click the Save button to save your changes.

11.8.1.17. Module: Monitor

Configure when you want to be alerted to failures in the cron job in an external monitoring software. You do not receive an alert in Mahara itself, but can use the CLI scripts to hook into your infrastructure monitoring tool.

Configure the cron job monitor plugin

Configure the cron job monitor plugin

  1. Cron lock hours: Enter a whole number for the maximum number of hours that a cron process should run before you are alerted to it failing. Default value: 2.

  2. Hours to consider Elasticsearch queue old: Enter a whole number to indicate after how many hours you want to be alerted when an entry in Elasticsearch hasn’t been processed. Default value: 1.

  3. LDAP suspended users percentage: Enter a whole number that indicates how many accounts can be suspended since midnight before you receive an alert. Default value: 10.

  4. Allowed IPs: List the IP addresses that can bypass the urlsecret config variable in order to access the cron job monitor.

  5. Klicken Sie auf den Speichern-Button, um Ihre Änderungen zu bestätigen.

Siehe auch

You can view results on the ‚Monitor‘ page and export them as CSV file if you do not have an external dashboard.

11.8.2. HTML-Filter

Administration menu → Extensions → HTML filters

Mahara verwendet HTML Purifier , um potenziell schädlichen Code bei Nutzereingaben auszufiltern. Um dennoch Code wie z.B. iFrames oder Javascript nutzen zu können, der sonst ausgefiltert würde, ist es erforderlich, Filter zu schreiben. Filter sollten immer nur spezifische Funktionen zulassen und nicht pauschal Freigaben erteilen, um die Sicherheit der Plattform nicht zu gefährden.

Mahara verfügt über eine Reihe integrierter Filter´. Weitere können hochgeladen und installiert werden. Neue HTML-Filter werden in den Ordner ‚//htdocs/lib/htmlpurifiercustom‘ geladen. Über den Installieren-Button werden sie im System verfügbar gemacht.

Custom filters for iFrames that allow the embedding of media content such as YouTube and WikiEducator allow authors to grab the URL of the page on which the media is displayed instead of having to find the actual embed code.

Bemerkung

Sie müssen nicht unbedingt die angesprochenen Filter für Medien verwenden. Sie können auch so Medien einbetten über den <iframe> embed code. Wenn Sie mit dem Original embed code zufrieden sind, können Sie die Quellseiten als erlaubte iframe Quellen definieren.

Wenn Sie jedoch die URL eintragen wollen (wie für ein Youtube-Video), dann sollten Sie die besprochenen Filter verwenden.

11.8.3. Erlaubte iframe Quellen

Administration menu → Extensions → Allowed iframe sources

This feature allows you as site administrator to specify the base URLs for media that you want authors to be able to embed. These iframes are then considered safe and will not be stripped out of a Text or Note block, the External media block or a journal entry where you can use them. You do not have to write bespoke filters for using these iframe sources.

The administrator interface allows you to add and manage these sources. Mahara already comes with a number of built-in iframe sources that you can take as examples.

Hinzufügen und bearbeiten zugelassener Iframe-Quellen

Hinzufügen und bearbeiten zugelassener Iframe-Quellen

  1. Display name: What the author will see in the external media block.

  2. Site: Basis-URL des iFrame-Codes

  3. Klicken Sie auf den Bearbeiten-Button zum Update des angezeigten Namens bei bestehenden iframe Quellen oder der Favicon Quelle.

  4. Klicken Sie auf den Löschen-Button , um eine existierende iFrame-Quelle zu entfernen.

  5. Display name: Change the display name of an existing iframe source here after having clicked the Edit button .

  6. Icon-Host: Wählen Sie die Basis-URL unter der das Favicon-Icon der Site gefunden werden kann, falls es nicht automatisch aktualisiert wird.

  7. Klicken Sie auf den Speichern-Button, um die Änderungen zu sichern.

  8. Site: Add a new iframe source by entering its base URL here. Please make sure to leave out the https://. Only letters, digits and . / - _ are allowed.

  9. Angezeigter Name: Wählen Sie einen Namen für die iFrame-Quelle. Üblicherweise ist das der Name der Seite von der der Inhalt bezogen wird.

  10. Klicken Sie auf den Hinzufügen-Button, um die Informationen über eine neue Seite der Liste erlaubter Quellen hinzuzufügen. Wenn das Favicon nicht angezeigt wird, kehren Sie zum Bearbeiten der Einstellungen (Schritt 6) zurück und prüfen Sie die hinterlegte URL.

Bemerkung

Some sites can be reached via a variety of URLs, e.g. GoogleApps, Glogster. You need to provide all possible base URLs to ensure that the iframes are displayed. If you give the individual sites of one provider the same name, it will only show up once in the list of iframe sources in the external media block and not clutter the space unnecessarily.

Siehe auch

Community members started to collect iframe sources that they are using on their sites to share which URLs would need to be provided to get the iframes to work. You can check out the list on the wiki and also add your own iframe sources there.

11.8.4. Lesbare URLs

Administration menu → Extensions → Clean URLs

You can configure your site to use human-readable URLs for personal profiles, groups and (group) portfolio pages. For example:

Diese Option ermöglicht es Ihnen leicht merkbare URLs zu erzeugen.

Siehe auch

Please follow the configuration instructions on the wiki for enabling this feature on your site. You need access to the server to do so.

In the administration area you can generate clean URLs for existing accounts, groups, and pages. This is handy when you upgraded from an earlier version of Mahara or want to reset all custom URLs.

Regenerate clean URLs for existing accounts in bulk

Regenerate clean URLs for existing accounts in bulk

  1. Klicken Sie auf den Bestätigen-Button, um lesbare URLs zu erzeugen. Alle bestehenden URLs werden dadurch geändert.

  2. Sie sehen das Ergebnis Ihrer Aktion oben auf der Seite

Warnung

If you generate clean URLs for all accounts from here, those who have already changed their URLs will lose their changes and links will be broken. We recommend you use this feature only when upgrading your Mahara site or when things have gone wrong with the clean URL generation.

11.8.5. Update embedded URLs

/admin/extensions/embeddedurls.php

When you migrate your site to a different domain, content such as images embedded into text or URLs pointing to pages and collections within text are not updated to the new domain automatically. This tool helps to update all of these instances in one go.

Update embedded URLs

Update embedded URLs

  1. Go to yourdomain/admin/extensions/embeddedurls.php.

  2. Old site URL: Enter the URL of your previous site.

  3. Click the Check URL button. Mahara now tries to find instances where the URL was used in embedded content.

  4. Results for …: A list of all instances where an embedded URL was found.

  5. Click the Update URLs button to change all instances to the new site URL.

Bemerkung

Use this tool instead of updating the URLs via a database query because text is stored serialised and can’t be updated via a SQL query.