Documentation
Need Production Features?
URLPixel offers 10x performance, site organization, and professional support.
Getting Started
Deploy URLPixel Open Source in minutes
Choose your preferred deployment method below. All methods provide the same core screenshot API functionality with different levels of complexity and control. For most users, we recommend starting with Railway for the fastest setup experience.
Choose Your Deployment Method
Railway Deploy
BeginnerDeploy to Railway
One-click deployment - no configuration needed
Step-by-Step Process
- 1Click the Railway deploy button
- 2Connect your GitHub account
- 3Wait for automatic build and deployment
- 4Use your Railway URL for screenshots
What happens during deployment?
- • Railway automatically clones the URLPixel Open Source repository
- • Node.js environment and dependencies are installed
- • Service starts and becomes available on your Railway subdomain
- • Health check endpoint confirms successful deployment
Test Your Deployment
Once your service is running, test it with this simple API call:
curl https://your-domain.com/healthcurl -X POST https://your-domain.com/screenshot \
-H "Content-Type: application/json" \
-d '{"url": "https://example.com"}'