Deployment Guide
Deployment Guide
Section titled “Deployment Guide”Learn how to deploy Puppeteer MCP in various environments, from local development to production scale.
Deployment Options
Section titled “Deployment Options”Deploy using npm for Node.js applications:
- Global installation guide
- Local project integration
- Publishing to npm registry
- Version management
- Package maintenance
Container-based deployment:
- Official Docker images
- Custom Dockerfile creation
- Docker Compose setup
- Container orchestration
- Security considerations
Enterprise production deployment:
- Infrastructure requirements
- Security hardening
- SSL/TLS configuration
- Monitoring setup
- Backup strategies
Scale Puppeteer MCP for high load:
- Horizontal scaling patterns
- Load balancing strategies
- Session distribution
- Resource optimization
- Performance tuning
Quick Start Deployments
Section titled “Quick Start Deployments”Local Development
Section titled “Local Development”# Using npx (no installation)npx puppeteer-mcp
# Or global installnpm install -g puppeteer-mcppuppeteer-mcp
Docker Deployment
Section titled “Docker Deployment”# Run with Dockerdocker run -d \ -p 3000:3000 \ -e PUPPETEER_MCP_AUTH_TOKEN=your-token \ williamzujkowski/puppeteer-mcp:latest
Production Deployment
Section titled “Production Deployment”version: '3.8'services: puppeteer-mcp: image: williamzujkowski/puppeteer-mcp:latest environment: - PUPPETEER_MCP_AUTH_TOKEN=${AUTH_TOKEN} - NODE_ENV=production ports: - '3000:3000' deploy: replicas: 3 resources: limits: memory: 2G
Deployment Checklist
Section titled “Deployment Checklist”Pre-Deployment
Section titled “Pre-Deployment”- Generate secure authentication tokens
- Review resource requirements
- Plan monitoring strategy
- Configure backups
- Test deployment process
Security
Section titled “Security”- Enable HTTPS/TLS
- Configure firewalls
- Set up rate limiting
- Review authentication
- Enable audit logging
Performance
Section titled “Performance”- Configure resource limits
- Set up load balancing
- Enable caching
- Configure CDN (if applicable)
- Optimize browser pool
Monitoring
Section titled “Monitoring”- Set up health checks
- Configure logging
- Enable metrics collection
- Set up alerts
- Plan incident response
Environment Requirements
Section titled “Environment Requirements”Minimum Requirements
Section titled “Minimum Requirements”- CPU: 2 cores
- RAM: 4GB
- Disk: 10GB
- Network: 100Mbps
Recommended Production
Section titled “Recommended Production”- CPU: 4+ cores
- RAM: 8GB+
- Disk: 50GB SSD
- Network: 1Gbps
Software Requirements
Section titled “Software Requirements”- Node.js: 20.0.0+
- Chrome/Chromium: Latest
- Docker: 20.10+ (if using containers)
Deployment Architectures
Section titled “Deployment Architectures”Single Instance
Section titled “Single Instance”Best for development and small teams:
[Client] → [Puppeteer MCP Server] → [Chrome]
Load Balanced
Section titled “Load Balanced”For medium traffic with redundancy:
[Clients] → [Load Balancer] → [MCP Servers] → [Chrome Pool]
Microservices
Section titled “Microservices”For large scale deployments:
[API Gateway] → [MCP Services] → [Session Manager] → [Chrome Cluster]
Common Deployment Scenarios
Section titled “Common Deployment Scenarios”1. Team Automation Server
Section titled “1. Team Automation Server”Deploy for internal team use:
- Single Docker container
- Basic authentication
- Shared browser pool
- Internal network only
2. SaaS Integration
Section titled “2. SaaS Integration”Deploy as part of a SaaS platform:
- Kubernetes deployment
- Multi-tenant isolation
- API rate limiting
- Usage monitoring
3. Enterprise Deployment
Section titled “3. Enterprise Deployment”Deploy for enterprise use:
- High availability setup
- Security compliance
- Audit logging
- Disaster recovery
Post-Deployment
Section titled “Post-Deployment”Health Monitoring
Section titled “Health Monitoring”# Check service healthcurl http://localhost:8443/health
# Check detailed statuscurl -H "Authorization: Bearer $TOKEN" \ http://localhost:8443/api/status
Performance Testing
Section titled “Performance Testing”# Load test with k6k6 run load-test.js
# Monitor resource usagedocker stats puppeteer-mcp
Troubleshooting
Section titled “Troubleshooting”- Check logs for errors
- Verify network connectivity
- Ensure Chrome dependencies
- Review resource limits
- Test authentication
Best Practices
Section titled “Best Practices”- Use Environment Variables for configuration
- Enable Monitoring from day one
- Plan for Scaling even if starting small
- Automate Deployments with CI/CD
- Regular Backups of configuration
- Security First approach
- Document Everything for your team
Next Steps
Section titled “Next Steps”Choose your deployment method:
- Simple setup? Try NPM Package
- Need containers? See Docker
- Going to production? Read Production Setup
- Planning for growth? Check Scaling Guide