Relyo home
English ENFrançais FR
Install free
Menu

Relyo for Joomla: documentation.

How to install Relyo on Joomla, check your site, read the problems and turn on the corrections.

Requirements

Joomla 5 or 6 and PHP 8.1 or later. Relyo is in English and French; multilingual sites (Language Filter and associations) are supported.

Install

  1. Download the free package: pkg_relyo-0.1.1.zip.
  2. In your Joomla administrator, open System → Install → Extensions, then the Upload Package File tab, and drop the zip file there.
  3. The package installs the Relyo component (Components → Relyo) and two plugins, System - Relyo and Task - Relyo, which are turned on for you.

New versions appear in System → Update → Extensions, like those of any other extension.

Check the whole site

  1. Open Components → Relyo → Dashboard and choose Check the whole site.
  2. Relyo loads each published, public article and menu item from your site, as a logged-out visitor sees it, and shows its progress page by page.
  3. Then, while the dashboard stays open, axe-core checks each page in your browser (contrast, ARIA and four more criteria). The dashboard says which page it is on; you can pause and resume these checks.

The dashboard then shows the site score, the open problems by severity, the most frequent problems and a score for each page. The score is the weighted share of the checks that pass: it is not an RGAA compliance rate.

Keep the results up to date

Relyo notes each article or menu item you save. To check those pages in the background, create a task in System → Manage → Scheduled Tasks:

  • Relyo: check changed pages checks the pages saved since their last check, 25 a run;
  • Relyo: check the whole site goes through every page, about 20 seconds a run.

Joomla runs Scheduled Tasks as visitors browse the site, or from your server's cron if you set one up.

Read and handle the problems

Components → Relyo → Problems lists each problem: what is wrong and what to do, the faulty element, its page and its RGAA criterion. Filter by problem, severity (blocking, important, minor) and status.

  • Ignore: when you have checked that a problem is not one, it stops counting in the score and stays ignored after later checks.
  • Correct, on an image without a proper text alternative: write the alternative, or say the image is only decorative. Relyo saves it in every article and custom module that shows the image; Joomla keeps the previous version of each article (Versions). An image that comes from your template or another extension has to be changed there.

Turn on the corrections

Components → Relyo → Corrections lists 8 corrections: skip link, visible keyboard focus, zoom, page language, frame titles, video and audio controls, image captions and form autofill. Each one says how many open problems it fixes on your site.

Tick a correction to turn it on. The System - Relyo plugin applies it to each public page as it is displayed: nothing is written in your content. Untick it and the page is back as your template makes it. Check the whole site again afterwards to update the scores.

When pages cannot be loaded

If a check says that pages could not be loaded, your server probably cannot reach the site's own public address: a container, a proxy or a firewall can cause that. Open Options on the dashboard, then the Advanced tab, and enter in Address used to load the pages the address your server should use instead, for example http://localhost/. Leave it empty otherwise.

Uninstall

In System → Manage → Extensions, select the package Relyo and choose Uninstall. Its component, plugins, tables and settings are removed; your content keeps the image alternatives you saved.

Help

A question, a page Relyo gets wrong? Write to us through the contact page or at contact@getrelyo.com. Relyo Pro adds 8 criteria and image alternatives written by AI: see Relyo Pro.