Skip to main content

Deployment

AWS Fargate is our main service used to deploy all things A11yWatch but, not limited to only AWS.

Getting Started

The quickest way to deploy the suite on the server is to install the A11yWatch CLI by running cargo install a11ywatch_cli on the server or in a Dockerfile and run the a11ywatch start command either in CMD or as a sidecar on your instance.

Docker

Another simple way to deploy is to use the @a11ywatch/a11ywatch docker image. By the default the main entry to the graphQL, and gRPC server starts on port 3280.

CLI

You can use the CLI and startup the instance normally or following the CLI section.

AWS EC2

Getting started on AWS EC2 linux with the following commands:

# update packages
sudo yum update -y
# install development tools cc
sudo yum groupinstall "Development Tools"
# install docker
sudo yum install docker -y
# start docker
sudo service docker start
# install command to group
sudo usermod -a -G docker ec2-user
# install docker compose
sudo curl -L https://github.com/docker/compose/releases/latest/download/docker-compose-$(uname -s)-$(uname -m) -o /usr/local/bin/docker-compose
# install rust
sudo curl https://sh.rustup.rs -sSf | sh -s -- -y
# configure shell to use new rust path
$HOME/.cargo/env
# install a11ywatch
cargo install a11ywatch_cli
# start a11ywatch
a11ywatch start
# run scan on website this works internally on the container too
a11ywatch scan --url https://a11ywatch.com --save

Make sure to update your security groups to allow inbound traffic on port 3280 for the API instance.