Skip to main content

Docker Setup

Run LUX locally using Docker.

Prerequisites​

  • Docker
  • Docker Compose

Quick Start​

Download the compose file and Dockerfile from the repository:

mkdir lux-deployment
cd lux-deployment

# Download Dockerfile
curl -O https://raw.githubusercontent.com/upskiller-xyz/server_lux/master/Dockerfile

# Create deployment directory
mkdir deployment

# Download docker-compose file
curl -o deployment/docker-compose-full-stack.yml \
  https://raw.githubusercontent.com/upskiller-xyz/server_lux/master/deployment/docker-compose-full-stack.yml

Start services:

docker-compose -f deployment/docker-compose-full-stack.yml up -d

Option 2: Pre-built Docker Image​

Pull and run the image:

# Docker image URL will be provided
docker pull <IMAGE_URL>
docker run -p 8080:8080 <IMAGE_URL>

Option 3: Clone and Deploy​

Clone the repository and run the deployment script:

git clone https://github.com/upskiller-xyz/server_lux.git
cd server_lux
bash deployment/deploy-full-stack.sh

Verify Deployment​

Check server status:

curl http://localhost:8080/

Expected response:

{
  "status": "running",
  "services": {
    "encoder": "ready",
    "merger": "ready",
    "model": "ready",
    "obstruction": "ready",
    "stats": "ready"
  }
}

Service Ports​

When running locally, services are available at:

ServicePortURL
Main Gateway8080http://localhost:8080
Obstruction8081http://localhost:8081
Encoder8082http://localhost:8082
Model8083http://localhost:8083
Merger8084http://localhost:8084
Stats8085http://localhost:8085

Common Operations​

View Logs​

docker-compose -f deployment/docker-compose-full-stack.yml logs -f

Stop Services​

docker-compose -f deployment/docker-compose-full-stack.yml down

Restart Services​

docker-compose -f deployment/docker-compose-full-stack.yml restart

Troubleshooting​

Port Conflicts​

If ports are already in use, modify port mappings in docker-compose-full-stack.yml:

ports:
  - '9080:8080' # Change left side to different port

Services Not Communicating​

Verify all containers are on the same network:

docker network ls
docker network inspect deployment_lux-network

Rebuild After Changes​

docker-compose -f deployment/docker-compose-full-stack.yml build --no-cache
docker-compose -f deployment/docker-compose-full-stack.yml up -d

Microservices​

See Microservices Architecture for detailed information about each service.

Next Steps​

API Reference - Complete endpoint documentation