Installation Guide

This guide provides detailed installation instructions for all supported platforms and deployment methods.

Installation Methods

Choose the installation method that best fits your environment:

Method Best For Difficulty Features
Docker Development, Testing Easy Quick setup, isolated
Docker Compose Local Development Easy Full stack with monitoring
Kubernetes/Helm Production Medium Scalable, enterprise-ready
Binary Simple deployments Easy Minimal dependencies
Systemd Linux servers Medium System service integration

Quick Start

For the fastest setup, use Docker:

docker run -d \
  --name cursor-exporter \
  -p 8080:8080 \
  -e CURSOR_API_TOKEN=your_token_here \
  ghcr.io/matanbaruch/cursor-admin-api-exporter:latest

Platform Support

Operating Systems

OS Binary Docker Kubernetes
Linux (AMD64) ✅ ✅ ✅
Linux (ARM64) ✅ ✅ ✅
macOS (Intel) ✅ ✅ ✅
macOS (ARM64) ✅ ✅ ✅
Windows ✅ ✅ ✅

Container Platforms

Platform Status Notes
Docker ✅ Recommended
Podman ✅ Compatible
containerd ✅ Via Kubernetes
CRI-O ✅ Via Kubernetes

Kubernetes Distributions

Distribution Status Notes
Vanilla Kubernetes ✅ Fully supported
Amazon EKS ✅ Tested
Google GKE ✅ Tested
Azure AKS ✅ Tested
Red Hat OpenShift ✅ Compatible
Rancher ✅ Compatible
k3s ✅ Compatible
MicroK8s ✅ Compatible

Prerequisites

General Requirements

  • API Token: Cursor Admin API token with appropriate permissions
  • Network Access: Outbound HTTPS access to api.cursor.com
  • Resources: Minimal (50MB RAM, negligible CPU)

Platform-Specific Requirements

Docker

  • Docker Engine 20.10+ or Docker Desktop
  • 50MB available disk space

Kubernetes

  • Kubernetes 1.19+
  • Helm 3.0+ (for Helm installation)
  • RBAC enabled cluster

Binary

  • No additional dependencies
  • Appropriate architecture binary

Installation Steps

1. Get API Token

Before installation, obtain your Cursor Admin API token:

  1. Log in to your Cursor team dashboard
  2. Navigate to Settings → API Keys
  3. Create a new API key with Admin permissions
  4. Copy the token for use in configuration

2. Choose Installation Method

Select your preferred installation method:

3. Configure and Deploy

Follow the specific guide for your chosen method:

4. Verify Installation

After installation, verify the exporter is working:

# Check health
curl http://localhost:8080/health

# Check metrics
curl http://localhost:8080/metrics

Next Steps

After installation:

  1. Configure Monitoring: Set up Prometheus and Grafana
  2. Set Up Alerts: Configure alerting rules
  3. Security Review: Implement security best practices
  4. Performance Tuning: Optimize for your environment

Need Help?

If you encounter issues during installation:

  1. Check the Troubleshooting Guide
  2. Review the Configuration Guide
  3. Search GitHub Issues
  4. Ask in GitHub Discussions

Choose your installation method: