Sign inSign up

nodeenterprise521/ne-autopilot-engine

By nodeenterprise521

•Updated 10 months ago

Image
0

779

nodeenterprise521/ne-autopilot-engine repository overview

⁠NE Autopilot Engine - Docker Hub Usage Guide

⁠Quick Start

⁠1. Pull the Image
docker pull nodeenterprise521/ne-autopilot-engine:latest
docker run --env-file .env nodeenterprise521/ne-autopilot-engine 

or if the env is not in the current run location

docker run -d \
  -e PERSON_ID="your-person-id" \
  -e NODE_ZERO_TOKEN="your-node-zero-token" \
  -e SUPABASE_URL="your-supabase-url" \
  -e SUPABASE_ANON_KEY="your-supabase-key" \
  -v $(pwd)/data:/app/data \
  -v $(pwd)/logs:/app/logs \
  --name autopilot-engine \
  nodeenterprise521/ne-autopilot-engine
⁠3. Run Interactively (For Testing)
docker run -it \
  -v $(pwd)/data:/app/data \
  nodeenterprise521/ne-autopilot-engine interactive

⁠Usage Options

⁠Production Deployment
# Create environment file
cat > .env << EOF
PERSON_ID=your-person-id
NODE_ZERO_TOKEN=your-node-zero-token
SUPABASE_URL=your-supabase-url
SUPABASE_ANON_KEY=your-supabase-key
ENCRYPTION_KEY=your-encryption-key
EOF

# Run with environment file
docker run -d \
  --env-file .env \
  -v $(pwd)/data:/app/data \
  -v $(pwd)/logs:/app/logs \
  -p 5000:5000 \
  --restart unless-stopped \
  --name autopilot-engine \
  nodeenterprise521/ne-autopilot-engine
⁠Development/Testing
# Interactive mode (manual input)
docker run -it nodeenterprise521/ne-autopilot-engine interactive

# Shell access for debugging
docker run -it nodeenterprise521/ne-autopilot-engine shell

# View help
docker run --rm nodeenterprise521/ne-autopilot-engine help

Create a docker-compose.yml file:

services:
  autopilot-engine:
    image: nodeenterprise521/ne-autopilot-engine:latest
    environment:
      - PERSON_ID=${PERSON_ID}
      - NODE_ZERO_TOKEN=${NODE_ZERO_TOKEN}
      - SUPABASE_URL=${SUPABASE_URL}
      - SUPABASE_ANON_KEY=${SUPABASE_ANON_KEY}
      - ENCRYPTION_KEY=${ENCRYPTION_KEY}
    volumes:
      - ./data:/app/data
      - ./logs:/app/logs
    ports:
      - "5000:5000"
    restart: unless-stopped

Then run:

# Create .env file with your values
echo "PERSON_ID=your-person-id" > .env
echo "NODE_ZERO_TOKEN=your-token" >> .env
echo "SUPABASE_URL=your-url" >> .env
echo "SUPABASE_ANON_KEY=your-key" >> .env

# Start the service
docker-compose up -d

⁠Environment Variables

VariableRequiredDescription
PERSON_IDYesYour unique person identifier
NODE_ZERO_TOKENRecommendedNode Zero API token
SUPABASE_URLOptionalSupabase database URL
SUPABASE_ANON_KEYOptionalSupabase API key
ENCRYPTION_KEYOptionalEncryption key for secure data

⁠Volume Mounts

Host PathContainer PathPurpose
./data/app/dataPersistent application data
./logs/app/logsApplication logs

⁠Commands

CommandDescription
start-engine (default)Start the autopilot engine
interactiveRun in interactive mode
shellOpen bash shell for debugging
helpShow usage information

⁠Container Management

# View logs
docker logs autopilot-engine

# Follow logs in real-time
docker logs -f autopilot-engine

# Stop container
docker stop autopilot-engine

# Remove container
docker rm autopilot-engine

# Update to latest version
docker pull nodeenterprise521/ne-autopilot-engine:latest
docker stop autopilot-engine
docker rm autopilot-engine
# Run with same command as before

⁠Platform Examples

⁠AWS EC2 Deployment
# On EC2 instance
sudo docker run -d \
  -e PERSON_ID="prod-user-123" \
  -e NODE_ZERO_TOKEN="your-token" \
  -v /home/ec2-user/autopilot-data:/app/data \
  -v /home/ec2-user/autopilot-logs:/app/logs \
  --restart unless-stopped \
  --name autopilot-engine \
  nodeenterprise521/ne-autopilot-engine
⁠Google Cloud Run
# Deploy to Cloud Run
gcloud run deploy autopilot-engine \
  --image nodeenterprise521/ne-autopilot-engine:latest \
  --set-env-vars PERSON_ID=your-id,NODE_ZERO_TOKEN=your-token \
  --platform managed \
  --region us-central1
⁠Azure Container Instances
# Deploy to Azure
az container create \
  --resource-group myResourceGroup \
  --name autopilot-engine \
  --image nodeenterprise521/ne-autopilot-engine:latest \
  --environment-variables PERSON_ID=your-id NODE_ZERO_TOKEN=your-token \
  --restart-policy Always
⁠Kubernetes Deployment
apiVersion: apps/v1
kind: Deployment
metadata:
  name: autopilot-engine
spec:
  replicas: 1
  selector:
    matchLabels:
      app: autopilot-engine
  template:
    metadata:
      labels:
        app: autopilot-engine
    spec:
      containers:
      - name: autopilot-engine
        image: nodeenterprise521/ne-autopilot-engine:latest
        env:
        - name: PERSON_ID
          value: "your-person-id"
        - name: NODE_ZERO_TOKEN
          valueFrom:
            secretKeyRef:
              name: autopilot-secrets
              key: node-zero-token
        volumeMounts:
        - name: data-volume
          mountPath: /app/data
        - name: logs-volume
          mountPath: /app/logs
      volumes:
      - name: data-volume
        persistentVolumeClaim:
          claimName: autopilot-data-pvc
      - name: logs-volume
        persistentVolumeClaim:
          claimName: autopilot-logs-pvc

⁠Troubleshooting

⁠Container Exits Immediately
  • Check that required environment variables are set
  • Use docker logs autopilot-engine to see error messages
  • Try running in interactive mode: docker run -it nodeenterprise521/ne-autopilot-engine interactive
⁠Permission Issues
  • Ensure host directories exist: mkdir -p data logs
  • Check directory permissions: chmod 755 data logs
⁠Interactive Mode Not Working
  • Use -it flags: docker run -it nodeenterprise521/ne-autopilot-engine interactive
  • Ensure terminal supports interactive input
⁠Environment Variables Not Loading
  • Verify environment variables are set: docker run --rm nodeenterprise521/ne-autopilot-engine shell -c "env | grep PERSON_ID"
  • Check .env file format if using --env-file

⁠Security Best Practices

  1. Use secrets management for sensitive data like API keys
  2. Don't include sensitive data in Dockerfiles or images
  3. Use environment variables or mounted secret files
  4. Run with non-root user (default in this image)
  5. Keep the image updated regularly

⁠Support

⁠License

This project is licensed under the terms specified in the LICENSE file.

Tag summary

Content type

Image

Digest

sha256:f2036ecf3…

Size

762.1 MB

Last updated

10 months ago

docker pull nodeenterprise521/ne-autopilot-engine