Skip to content

docker.md

Latest commit

 

History

History
202 lines (143 loc) · 3.45 KB

docker.md

File metadata and controls

202 lines (143 loc) · 3.45 KB

Docker Deployment

This guide explains how to deploy and run Kexa using Docker containers.

Prerequisites

  • Docker installed on your system
  • Docker Compose (optional, for multi-container setups)
  • Access to cloud provider accounts (AWS, Azure, GCP)

Quick Start

Using Docker Hub Image

# Pull the latest image
docker pull innovtech/kexa:latest

# By default, the container will run in the background and check the website "kexa.io"
docker run -d \
  --name kexa \
  -v $(pwd)/output:/app/output \
  -v $(pwd)/rules:/app/rules \
  -v $(pwd)/config:/app/config \
  innovtech/kexa:latest

# The result will be inside the "output" folder on your computer

Using Docker Compose

Create a docker-compose.yml file:

version: "3.8"

services:
  kexa:
    image: innovtech/kexa:latest
    container_name: kexa
    volumes:
      - ./output:/app/output
      - ./rules:/app/rules
      - ./config:/app/config
      - ./.env:/app/.env
    restart: unless-stopped

Run with:

docker-compose up -d

Building from Source

1. Clone the Repository

git clone https://github.com/kexa-io/Kexa.git
cd Kexa

2. Build the Image

docker build -t kexa .

3. Run the Container

docker run -d \
  --name kexa \
  -v $(pwd)/output:/app/output \
  -v $(pwd)/rules:/app/rules \
  -v $(pwd)/config:/app/config \
  kexa

Configuration

Environment Variables

Create a .env file with your configuration:

# Rules directory
RULESDIRECTORY=/app/rules

# Output directory
OUTPUT=/app/output

# Provider authentication variables
# (Add your provider-specific variables)

Volume Mounts

  • /app/rules: Rules directory
  • /app/output: Output directory
  • /app/config: Config directory
  • /.env: Environment variables

Monitoring

Logs

# View container logs
docker logs kexa

# Follow logs in real-time
docker logs -f kexa

Container Status

# Check container status
docker ps -a | grep kexa

# View container details
docker inspect kexa

Maintenance

Updates

# Pull latest image
docker pull innovtech/kexa:latest

# Stop and remove old container
docker stop kexa
docker rm kexa

# Run new container
docker run -d \
  --name kexa \
  -v $(pwd)/output:/app/output \
  -v $(pwd)/rules:/app/rules \
  -v $(pwd)/config:/app/config \
  innovtech/kexa:latest

Backup

# Backup rules
docker cp kexa:/app/rules ./rules-backup

# Backup output
docker cp kexa:/app/output ./output-backup

Security Considerations

  1. Container Security

    • Run container as non-root user
    • Use read-only volumes where possible
    • Implement resource limits

  2. Network Security

    • Use Docker network isolation
    • Implement proper firewall rules
    • Monitor container network access

  3. Secret Management

    • Use Docker secrets for sensitive data
    • Implement proper credential rotation
    • Secure environment variables

Troubleshooting

Common Issues

  1. Container Won't Start

    • Check container logs
    • Verify volume permissions
    • Ensure environment variables are set

  2. Permission Issues

    • Check volume ownership
    • Verify file permissions
    • Ensure proper user mapping

  3. Network Issues

    • Check network connectivity
    • Verify DNS settings
    • Ensure proper port mapping

Next Steps