Skip to content
Convermax Docs

Running Convermax Search Server Locally

This guide explains how to download and run a Convermax search node in your local environment.

Eligibility

This feature is available for:

  • Stage 3 plan customers
  • Enterprise custom agreements

Benefits and Considerations

Benefits

  • Reduced latency for search operations
  • Integration with your existing infrastructure:
    • Custom firewall configurations
    • Reverse-proxy setup
    • Monitoring tools
    • Performance optimization for specific workloads
  • Direct access to internal ERP systems for real-time price and inventory updates
  • Full control over CPU and memory allocation

Considerations

  • You are responsible for deploying updates on time
  • Recommended: Implement blue-green deployments and rollback procedures
  • Consider the complexity of building a geo-distributed, load-balanced infrastructure

Requirements

Hardware Requirements

  • CPU: Minimum 2 cores (higher frequency preferred over more cores)
  • RAM: Minimum 8GB (16GB recommended for optimal performance)
  • Storage: 50GB NVMe SSD or better (performance is critical)

Software Requirements

  • Docker
  • GitHub CLI (gh)

Installation Steps

1. Request Access

Email [email protected] with your GitHub account username to request access to the package repository.

2. Authenticate with GitHub

Run the following commands, replacing GitHub-username with your actual GitHub username:

Terminal window
gh auth login --scopes read:packages
gh auth token | docker login ghcr.io -u GitHub-username --password-stdin

3. Prepare Environment Variables

  1. Contact your Convermax support representative to obtain a template of the vars file
  2. Configure the file with your specific environment variables

4. Check Latest Version

Visit Convermax Packages to find the latest available build version.

5. Start the Container

Run the following command, adjusting the paths and version as needed:

Terminal window
docker run \
  --name site-search \
  --restart unless-stopped \
  -p 18080:8081 \
  --env-file /path/to/your/vars \
  -e REDIS=redis.convermax.com \
  -e NODELABELS=your_store_id \
  -d ghcr.io/convermax/sitesearch:5.0.2324.0

Command Parameters Explained:

  • --name site-search: Names your container
  • --restart unless-stopped: Automatically restarts the container when Docker starts
  • -p 18080:8081: Maps container port 8081 to host port 18080
  • --env-file: Path to your environment variables file
  • -e REDIS: Redis server configuration
  • -e NODELABELS: Your store identifier
  • -d: Runs the container in detached mode (background)

Container Management

You can use various container management solutions:

  • HashiCorp Nomad
  • Docker Swarm
  • Other container orchestration tools

Data Persistence

To persist data between container restarts, mount an external volume:

Terminal window
-v /opt/convermax/data:/opt/convermax/data

Add this parameter to your docker run command to store data in a persistent location.