Skip to main content

Installation

Actyze can be deployed using Docker Compose for local development or Helm for production Kubernetes deployments.

Prerequisites​

For Docker Deployment​

  • Docker Engine 20.10+
  • Docker Compose 2.0+
  • 8GB+ RAM available for Docker
  • Internet connection for LLM API access

For Kubernetes Deployment​

  • Kubernetes cluster (v1.24+)
  • Helm 3.x installed
  • kubectl configured to access your cluster
  • 4GB+ RAM per node

Choose Your Deployment Method​

Docker Compose (Local Development & Testing)​

Best for:

  • Local development
  • Testing and evaluation
  • Quick prototyping
  • Single-machine deployments

→ Docker Installation Guide

Helm Charts (Production Kubernetes)​

Best for:

  • Production deployments
  • High availability
  • Scalability
  • Enterprise environments

→ Helm Installation Guide

Quick Start: Docker Compose​

1. Clone the Repository​

git clone https://github.com/actyze/dashboard-docker.git
cd dashboard

2. Configure Environment​

# Copy environment template
cp docker/env.example docker/.env

# Edit with your API keys
nano docker/.env

Add your LLM API key:

# LLM Configuration
PERPLEXITY_API_KEY=your-api-key-here
EXTERNAL_LLM_PROVIDER=perplexity
EXTERNAL_LLM_AUTH_TYPE=bearer

# Database Configuration
POSTGRES_PASSWORD=dashboard_password
POSTGRES_USER=dashboard_user
POSTGRES_DB=dashboard

3. Start Services​

# Start all services
./docker/start.sh

# Or use Docker Compose directly
cd docker
docker-compose up -d

4. Access Actyze​

Open your browser to:

Quick Start: Helm​

1. Clone Helm Charts Repository​

git clone https://github.com/actyze/helm-charts.git
cd helm-charts

2. Configure Secrets​

# Copy secrets template
cp dashboard/values-secrets.yaml.template dashboard/values-secrets.yaml

# Edit with your credentials
nano dashboard/values-secrets.yaml

3. Deploy to Kubernetes​

helm install dashboard ./dashboard \
  --namespace actyze \
  --create-namespace \
  --values dashboard/values.yaml \
  --values dashboard/values-secrets.yaml

4. Access Actyze​

# Port-forward to access locally
kubectl port-forward -n actyze svc/dashboard-frontend 3000:3000

# Or configure Ingress for external access

Open http://localhost:3000

Verify Installation​

Check Service Health​

Docker:

docker-compose ps
docker-compose logs -f

Kubernetes:

kubectl get pods -n actyze
kubectl get svc -n actyze

Test API Endpoint​

# Health check
curl http://localhost:8000/health

# Expected response:
{
  "status": "healthy",
  "services": {
    "database": "connected",
    "llm": "configured"
  }
}

Default Credentials​

Actyze uses your organization's authentication system. For initial setup, you can create an admin user through the API or configure SSO.

Important: Set up proper authentication before exposing to users.

Next Steps​

After installation:

  1. Configure LLM Provider - Set up your AI model
  2. Connect Your Database - Link to Trino or PostgreSQL
  3. Quick Start Guide - Learn how to use Actyze

Troubleshooting​

Docker Issues​

Port conflicts:

# Check what's using the ports
lsof -i :3000
lsof -i :8000

# Stop conflicting services or change ports in docker-compose.yml

Memory issues:

# Check Docker memory allocation
docker stats

# Increase Docker Desktop memory limit to 8GB+

Kubernetes Issues​

Pods not starting:

# Check pod status
kubectl describe pod <pod-name> -n actyze

# Check logs
kubectl logs <pod-name> -n actyze

Image pull errors:

# Verify image pull secrets
kubectl get secrets -n actyze

# Check image names in values.yaml

Support​

Need help with installation?