Installation

FlexibleDeployment Methods

Support multiple deployment methods, from quick testing to production environments. Choose the deployment solution that best fits your needs.

System Requirements

Ensure your environment meets the following basic requirements

Hardware Requirements

  • CPU: 2 cores (4 cores recommended)
  • Memory: 2GB (4GB recommended)
  • Disk: 10GB available space
  • Network: 100Mbps bandwidth

Software Requirements

  • Java 17 or higher
  • Docker 20.0+ (recommended)
  • Kubernetes 1.20+ (for K8s deployment)
  • Linux/Windows/macOS

Network Requirements

  • Access to Elasticsearch cluster
  • Port 8000 available (default)
  • Outbound network access
  • Firewall rules configuration

Choose Deployment Method

Select the most suitable deployment method based on your needs and environment

Docker Deployment

Recommended approach, quick and simple, suitable for most scenarios

Simple⏱ 5 minutes
  • One-click deployment
  • Environment isolation
  • Easy to manage
  • Orchestration support

Kubernetes Deployment

Cloud-native deployment with auto-scaling and high availability support

Moderate⏱ 15 minutes
  • Auto-scaling
  • High availability
  • Load balancing
  • Health checks

Native Deployment

Traditional deployment method with full control over environment configuration

Moderate⏱ 10 minutes
  • Full control
  • Optimal performance
  • Custom configuration
  • System integration

Docker Deployment

Recommended deployment method, simple and fast, suitable for development and production environments

Quick Start

Docker Quick Start
# Quick start ElasticProxy
docker run -d \
  --name elasticproxy \
  --restart unless-stopped \
  -p 8000:8000 \
  -e ELASTICSEARCH_URL=http://your-es:9200 \
  elasticproxy/server:latest

Production Configuration

Production Deployment
# Create configuration directory
mkdir -p /opt/elasticproxy/{config,logs,data}

# Create configuration file
cat > /opt/elasticproxy/config/application.yml << EOF
elasticsearch:
  url: http://elasticsearch:9200
  username: "elastic"
  password: "your_password"
  
server:
  port: 8000
  
proxy:
  allowList: ["10.0.0.0/24"]
  limits:
    rateLimit: 500/minute
EOF

# Start container
docker run -d \
  --name elasticproxy \
  --restart unless-stopped \
  -p 8000:8000 \
  -v /opt/elasticproxy/config:/app/config \
  -v /opt/elasticproxy/logs:/app/logs \
  elasticproxy/server:latest

Need Deployment Help?

Our technical team can assist you with deployment and configuration