Installation Guide

Prerequisites

Java 17 or higher
Magnolia CMS 6.4 or higher
Maven 3.6 or higher
Node.js 18 (for building from source)

1. Register the easya11y Workspace

Easy Accessibility requires a custom JCR workspace to store scan results and configuration. Add the following to your Magnolia repositories.xml:

Add to <RepositoryMapping>:

<Map name="easya11y" repositoryName="magnolia" workspaceName="easya11y" />

Add to <Repository name="magnolia">:

<workspace name="easya11y" />

Example location: WEB-INF/config/default/repositories.xml

2. Configure Storage (Optional)

By default, Easy Accessibility uses JCR storage. To explicitly configure this, create a config.yaml in your light module decorations:

your-light-module/
  decorations/
    easya11y/
      config.yaml

config.yaml contents:

storageType: jcr

3. Restart Magnolia

After modifying repositories.xml, restart Magnolia to create the new workspace. The module's bootstrap files will initialize the required nodes (/configuration and /scanResults) on first startup.

Building from Source

If you want to build Easy Accessibility from source:

Install dependencies:

npm install

Build frontend assets:

npm run build

Build the module:

mvn clean package

Troubleshooting

"Error retrieving configuration: null" or 500 errors

The easya11y workspace is not registered. Follow the installation steps above.
Restart Magnolia after modifying the repository configuration.

Pages not loading in scanner

Check CORS settings on your Magnolia instance.
Verify the page URL is accessible from the browser.
Check browser console for errors.

Scan results not saving

Verify the easya11y workspace exists in repositories.xml.
Check Magnolia logs for permission errors.
Ensure the REST endpoints are properly configured.

Next Steps

Once installed, access the Accessibility Checker from the Magnolia AdminCentral app launcher. You can scan individual pages or browse your site to scan multiple pages at once.

View release notes