Skip to main content
Humancheck Open Source is the core package that you can self-host for complete control over your data, deployment, and customization.

Installation

Install the core package:
pip install humancheck
Or install from source:
git clone https://github.com/shashisp/humancheck.git
cd humancheck
poetry install

Base URL

When self-hosting, use your own base URL:
http://localhost:8000  # Local development
https://your-domain.com  # Production deployment

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

pip install humancheck

2. Initialize Configuration

humancheck init
This creates a humancheck.yaml configuration file.

3. Start the Services

humancheck start
This launches:

4. Make Your First Request

import httpx

async with httpx.AsyncClient() as client:
    response = await client.post(
        "http://localhost:8000/reviews",  # Your self-hosted URL
        json={
            "task_type": "payment",
            "proposed_action": "Process payment of $5,000",
            "agent_reasoning": "High-value payment requires approval",
            "confidence_score": 0.85,
            "urgency": "high"
        }
    )
    review = response.json()
    print(f"Review ID: {review['id']}")

Configuration

Edit humancheck.yaml to customize:
# API Server Configuration
api_host: 0.0.0.0
api_port: 8000

# Dashboard Configuration
streamlit_host: 0.0.0.0
streamlit_port: 8501

# Database Configuration
storage: sqlite  # or postgresql
db_path: ./humancheck.db

# Authentication (optional)
enable_auth: false
api_key: null

Deployment

Docker Deployment

docker run -p 8000:8000 -p 8501:8501 humancheck/humancheck

Production Deployment

For production, we recommend:
  1. Use PostgreSQL instead of SQLite
  2. Enable authentication with API keys
  3. Set up reverse proxy (nginx, Traefik, etc.)
  4. Configure SSL/TLS certificates
  5. 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

FeatureOpen SourcePlatform
Base URLYour own domainhttps://api.humancheck.dev
SetupSelf-hostedManaged cloud
DatabaseYou manageManaged
UpdatesManualAutomatic
SupportCommunityPriority support
CostFree (self-hosted)Paid plans
CustomizationFull controlLimited

Next Steps