Installation
Install the core package:Base URL
When self-hosting, use your own base URL:Features
- Core Package: All core functionality included
- Self-Hosted: Deploy on your infrastructure
- Full Control: Complete control over data and deployment
- Customizable: Modify and extend as needed
- Open Source: MIT licensed
Getting Started
1. Install
2. Initialize Configuration
humancheck.yaml configuration file.
3. Start the Services
- API Server: http://localhost:8000
- Dashboard: http://localhost:8501
4. Make Your First Request
Configuration
Edithumancheck.yaml to customize:
Deployment
Docker Deployment
Production Deployment
For production, we recommend:- Use PostgreSQL instead of SQLite
- Enable authentication with API keys
- Set up reverse proxy (nginx, Traefik, etc.)
- Configure SSL/TLS certificates
- Set up monitoring and logging
Self-Hosting Options
Docker
Deploy using Docker containers
Kubernetes
Deploy on Kubernetes clusters
Cloud VMs
Deploy on AWS, GCP, Azure VMs
On-Premise
Deploy on your own infrastructure
Customization
Since you’re self-hosting, you can:- Modify the source code
- Add custom adapters
- Create custom connectors
- Extend the dashboard
- Add custom routing logic
- Integrate with your auth system
Differences from Platform
| Feature | Open Source | Platform |
|---|---|---|
| Base URL | Your own domain | https://api.humancheck.dev |
| Setup | Self-hosted | Managed cloud |
| Database | You manage | Managed |
| Updates | Manual | Automatic |
| Support | Community | Priority support |
| Cost | Free (self-hosted) | Paid plans |
| Customization | Full control | Limited |
Next Steps
- Check out the Quickstart Guide for Open Source
- Learn about Configuration
- See Deployment Options
- Review Contributing Guide