Skip to main content

​
Quickstart Guide

Get apilens up and running quickly using Docker.

​
Prerequisites

Before you begin, ensure you have:
Docker installed (Get Docker)
Docker Compose installed
At least 4GB RAM available

​
One-Command Setup

The fastest way to get started is using our quickstart script: 
# Clone the repository
git clone https://github.com/apilens-in/apilens.git
cd apilens

# Run the quickstart script
./scripts/quickstart.sh
This will:
  1. Create a .env file with generated secrets
  2. Start all services (PostgreSQL, ClickHouse, Redis, Backend, Frontend)
  3. Run database migrations
  4. Create a default admin user
The quickstart script creates a default admin user with email admin@apilens.local and password admin. Change this immediately in production!

​
Access the Application

Once the setup completes, access:
ServiceURL
Dashboardhttp://localhost
APIhttp://localhost/api/v1/
API Docshttp://localhost/api/v1/docs
Admin Panelhttp://localhost/admin/

​
Send Your First Metric

Test the API by sending a metric: 
curl -X POST http://localhost/api/v1/metrics/ \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
    "name": "api.request.duration",
    "value": 42.5,
    "tags": {
      "endpoint": "/users",
      "method": "GET"
    }
  }'

​
Check Health Status

Verify all services are running: 
# Check API health
curl http://localhost/api/v1/health/

# Check readiness (includes database checks)
curl http://localhost/api/v1/health/ready/
Expected response: 
{
  "status": "healthy",
  "version": "1.0.0"
}

​
View Logs

To see what’s happening: 
# View all logs
docker-compose -f docker-compose.prod.yml logs -f

# View specific service logs
docker-compose -f docker-compose.prod.yml logs -f backend

​
Stop the Application

docker-compose -f docker-compose.prod.yml down
To also remove data volumes: 
docker-compose -f docker-compose.prod.yml down -v

​
Next Steps

Full Installation

Detailed installation options

Configuration

Configure environment variables

Send Metrics

Learn to send metrics from your app

API Reference

Explore all API endpoints