Quick Start

5-Minute DeploymentElasticProxy

Follow this guide to complete the deployment and configuration of ElasticProxy in minutes, and start protecting your Elasticsearch cluster immediately.

Total time: 5 minutes
CLI required
Production ready

Before You Start

Make sure you have the following environment ready:

  • • A running Elasticsearch cluster (7.x or 8.x)
  • • A server or local environment with Docker installed
  • • Administrator privileges (for port binding and file operations)

Deployment Steps

Follow these steps to quickly deploy ElasticProxy.

01

Prerequisites

1 minute

Ensure your environment meets the basic requirements.

  • Java 17 or higher
  • Docker (recommended) or direct deployment environment
  • Accessible Elasticsearch cluster
  • Port 8000 available (default port)
Terminal Command
# Check Java version
java -version

# Check Docker version
docker --version

# Check if port is available
netstat -tuln | grep 8000
02

Download & Deploy

2 minutes

One-click deployment of ElasticProxy using Docker.

  • Pull the latest Docker image
  • Create a configuration file
  • Start the container service
  • Verify service status
Terminal Command
# Pull ElasticProxy image
docker pull elasticproxy/server:latest

# Create configuration directory
mkdir -p /opt/elasticproxy/config

# Download configuration template
curl -o /opt/elasticproxy/config/application.yml https://raw.githubusercontent.com/elasticproxy/server/main/config/application.yml
03

Basic Configuration

1 minute

Modify the configuration file to connect to your Elasticsearch.

  • Set the Elasticsearch connection address
  • Configure authentication information (if needed)
  • Adjust the service port (optional)
  • Set basic security policies
Terminal Command
# Edit configuration file
vim /opt/elasticproxy/config/application.yml

# Key configuration items:
elasticsearch:
  url: http://your-es-cluster:9200
  username: "elastic"
  password: "your_password"

server:
  port: 8000

proxy:
  allowList: ["10.0.0.0/24"]  # Allowed IP range
04

Start Service

30 seconds

Start the ElasticProxy proxy service.

  • Start the service using Docker
  • View startup logs
  • Confirm that the service is running normally
  • Check health status
Terminal Command
# Start ElasticProxy service
docker run -d --name elasticproxy --restart unless-stopped -p 8000:8000 -v /opt/elasticproxy/config:/app/config elasticproxy/server:latest

# View startup logs
docker logs elasticproxy -f
05

Verify Deployment

30 seconds

Test the proxy function and connection status.

  • Health check interface test
  • Proxy function verification
  • View monitoring indicators
  • Test query protection
Terminal Command
# Health check
curl http://localhost:8000/actuator/health

# Test proxy function
curl -X GET "http://localhost:8000/_cluster/health"

# Test search proxy
curl -X POST "http://localhost:8000/your-index/_search" -H "Content-Type: application/json" -d '{"query":{"match_all":{}},"size":1}'

Troubleshooting

Encountering issues? Check these common solutions.

Port 8000 is occupied

Modify the server.port configuration in the configuration file, or stop the process that is occupying the port.

Failed to connect to Elasticsearch

Check if the ES address, network connectivity, and authentication information are correct.

Failed to pull Docker image

Check your network connection, or use a domestic mirror source.

Deployment Complete! What's Next?

Congratulations! You have successfully deployed ElasticProxy. Now you can perform more in-depth configuration and optimization.

Need help or have questions?

Our technical team is always here to support you.