Free scanFree scan

Install guide · Plugin

Install the visitor toolbar on Moodle

By Published

How to add the visitor toolbar to Moodle. The toolbar lets a visitor change how your pages look and read for themselves; it fixes nothing in your site, does not change whether it meets WCAG or the BFSG, and our scans never see it.

Before you start

  • Your site key. It is in the Reviseberg dashboard, under Settings › Visitor toolbar, on the Install tab. In the steps below it is written YOUR-SITE-KEY.
  • Switch the toolbar on for your site on the same screen. Until it is on, the tag loads and shows nothing.
  • What the platform needs: Moodle 4.1+.

Download

The package is reviseberg-toolbar-moodle-1.0.0.zip. It is not listed in any platform’s store yet: you install it from this download.

Download for Moodle (version 1.0.0)

Steps

  1. Download the plugin above.
  2. As an administrator, go to Site administration › Plugins › Install plugins, upload the zip and click Install plugin from the ZIP file. Confirm the checks and upgrade the database.
  3. On the settings page Moodle shows after the upgrade, paste your site key and switch the toolbar on. You find the same page later under Site administration › Plugins.

Good to know

If installing from a zip is switched off on your site, unpack the plugin into the folder for its type and open Site administration › Notifications to finish.

The plugin is not in the Moodle plugins directory yet.

Check that it works

  • Open a page of your site in a private window — not in the platform’s editor or preview, where most plugins leave the tag out on purpose.
  • View the page source, or search the developer tools’ Elements panel, for widget/v1.js. There should be exactly one tag, with your key.
  • The toolbar’s button appears once the toolbar is switched on in the dashboard. On the same screen, “Last seen on your site” says when the tag last loaded on one of your pages.
  • No button? The browser console has a line beginning “Reviseberg toolbar:” that says why — a key with the wrong shape, for example, or the tag on the page twice.
  • The toolbar answers only on the addresses allowed under Settings › Visitor toolbar; your site’s own address always is. Add a staging address there before you test on it.

More