Installation
Install the core package:Base URL
When self-hosting, use your own base URL:Features
Core HITL Functionality
- ✅ Review Management: Create, track, and manage review requests
- ✅ Decision Making: Approve, reject, or modify actions
- ✅ Feedback System: Rate and comment on reviews
- ✅ Attachments: Upload and preview files (images, documents, code)
- ✅ Framework Adapters: REST API, MCP, LangChain, Mastra
- ✅ Basic Routing: Simple config-based routing rules (YAML)
- ✅ Connectors: Slack, Email, Webhook notifications
- ✅ Dashboard: Streamlit-based review interface
- ✅ Statistics: Basic review analytics
Self-Hosted Benefits
- Full Control: Complete control over data and deployment
- Customizable: Modify and extend as needed
- Open Source: MIT licensed
- No Vendor Lock-in: Your data, your infrastructure
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
For advanced features like multi-tenancy, organizations, teams, dozens of built-in connectors, no-code integrations (n8n, Zapier, Gumloop), multi-user approval workflows, advanced webhooks, evals, and OAuth connectors, check out Humancheck Platform.
Configuration
Configure routing and reviewers inhumancheck.yaml:
Next Steps
- Check out the Quickstart Guide
- Learn about Configuration
- Explore Integrations
- Review Contributing Guide