Installing On-Premises Axe DevTools Linter with Docker
Learn how to install and run the on-premises edition of Axe DevTools Linter using Docker, from Docker Hub, a tar file, or the Deque Agora artifactory.
The on-premises edition of Axe DevTools Linter can be installed using Docker. This guide covers three methods: pulling the public image from Docker Hub, loading a Docker image from a tar file, or pulling the image from the Deque Agora artifactory.
You will need a license key to use the on-premises edition of Axe DevTools Linter. A license key is not the same as an API key used for the SaaS edition. Contact Deque's help desk to obtain your license key.
The Axe DevTools Linter Docker images are built for the linux/amd64 platform. On Apple Silicon Macs, you may see a warning: image platform (linux/amd64) does not match the expected platform (linux/arm64). The image will still run correctly under emulation.
Pulling from Docker Hub
The Axe DevTools Linter image is available on Docker Hub.
Pull the Image
docker pull dequesystems/axe-linter:latestYou can also pull a specific version by replacing latest with a version tag (e.g., dequesystems/axe-linter:4.10.2).
Run the Container (Docker Hub)
Set your license key and run the container:
export AXE_LINTER_LICENSE_KEY=<license-key>
docker run -it --privileged -e AXE_LINTER_LICENSE_KEY="$AXE_LINTER_LICENSE_KEY" -p 3000:3000 dequesystems/axe-linterInstalling from a Docker Tar File
If you have received a Docker tar file from Deque, you can load and run the image directly.
Download the Tar File
Download the tar file from Agora.
Load the Docker Image
Load the Docker image from the tar file:
docker load -i /path/to/axe_linter_customer.tarRun the Container (Created from the Tar File)
Once the image is loaded, run the container:
docker run -it --privileged -p 3000:3000 axe_linter_customer:latestPulling from the Agora Artifactory
You can also pull the Docker image directly from the Deque Agora artifactory.
Log In to the Artifactory
Authenticate with the Agora Docker registry using your Agora username and API key:
docker login -u <agora-user> -p <agora-api-key> agora.dequecloud.com:1083Pull the Docker Image
Pull the latest Axe DevTools Linter image:
docker pull agora.dequecloud.com:1083/axe-linter/axe-linter-customer:latestRun the Container (Agora)
Start the container:
docker run -it --privileged -p 3000:3000 agora.dequecloud.com:1083/axe-linter/axe-linter-customer:latestVerifying the Installation
After starting the container, the Axe DevTools Linter service will be available on port 3000. You can verify it is running by checking the healthcheck endpoint:
By default, the container listens on unencrypted port 3000. For production environments, consider setting up a reverse proxy to provide SSL/TLS encryption.
curl http://localhost:3000/healthcheckA successful response returns the service version:
{"version":"4.10.2"}Next Steps
- To encrypt connections to your Docker instance using NGINX, see Using Axe DevTools Linter with a Reverse Proxy.
- To connect clients to your server, see Using Axe DevTools Linter Connector.
- For a non-Docker installation using the Linux binary, see Setting up the On-Premises Edition of Axe DevTools Linter.