Ryan Hamilton
934a22b4bb
Some checks failed
Build and Push Docker Image / build-and-push (push) Failing after 58s
47 lines
1.3 KiB
Markdown
47 lines
1.3 KiB
Markdown
# Pa11y Dashboard Docker Project Summary
|
|
|
|
## What This Provides
|
|
|
|
A minimal Docker setup for Pa11y Dashboard that:
|
|
|
|
1. **Builds automatically** via Gitea workflows when pushed to main/master
|
|
2. **Pushes to your Gitea container registry**
|
|
3. **Provides easy deployment** with docker-compose
|
|
4. **Includes MongoDB** for data persistence
|
|
5. **Configurable via environment variables**
|
|
|
|
## Key Files
|
|
|
|
- **Dockerfile**: Multi-stage build that pulls Pa11y Dashboard v4.2.0 from GitHub
|
|
- **docker-compose.yml**: Runs pa11y-dashboard + MongoDB with health checks
|
|
- **.gitea/workflows/build.yml**: Automated build and push to your Gitea registry
|
|
- **.env.example**: Simple configuration template
|
|
|
|
## Quick Deploy
|
|
|
|
```bash
|
|
# 1. Copy environment template
|
|
cp .env.example .env
|
|
|
|
# 2. Start services
|
|
docker-compose up -d
|
|
|
|
# 3. Access at http://localhost:4000
|
|
```
|
|
|
|
## Gitea Registry
|
|
|
|
The workflow will automatically:
|
|
- Build the Docker image on push to main/master
|
|
- Tag with branch name, latest, and commit SHA
|
|
- Push to `gitea.portal.tulsacounty.org/your-repo-name`
|
|
|
|
## Environment Variables
|
|
|
|
- `PA11Y_PORT=4000` - Host port
|
|
- `READONLY=false` - Make read-only
|
|
- `SITE_MESSAGE=""` - Homepage message
|
|
- `WEBSERVICE_CRON=false` - Auto-testing schedule
|
|
|
|
That's it! Simple and focused on your Gitea workflow needs.
|