Pa11y Dashboard Docker

A Docker container for Pa11y Dashboard - a web interface for the Pa11y accessibility testing tool.

Quick Start

1. Create environment configuration:

   cp .env.example .env
   

2. Start the services:

   docker-compose up -d
   

3. Access the dashboard:

   • Open your browser to http://localhost:4000

Configuration

Edit the .env file to customize the deployment:

# Basic settings
PA11Y_PORT=4000              # Port to expose on host
READONLY=false               # Make dashboard read-only
SITE_MESSAGE=                # Custom homepage message

# Automation
WEBSERVICE_CRON=false        # Enable automatic testing (cron format)

Docker Compose Services

• pa11y-dashboard: The main dashboard application (port 4000)
• mongodb: Database for storing test results and configuration

Usage

1. Navigate to http://localhost:4000
2. Click "Add URL" to add websites to test
3. Configure accessibility standards (WCAG2AA recommended)
4. Run tests and view detailed reports

Building

The image is automatically built and pushed to the Gitea registry via GitHub Actions when code is pushed to main/master branches.

To build manually:

docker build -t pa11y-dashboard .

License

This Docker packaging is provided under the MIT License. Pa11y Dashboard itself is licensed under GPL-3.0.