Installation Guide

AiAgentNexus Installation Guide

Welcome to the AiAgentNexus Front Installation Guide! Whether you're a developer exploring the platform, a system integrator configuring a tailored solution, or an enterprise setting up a white-label AI system, this guide will provide you with step-by-step instructions to get started.


🧩 Build-Your-Own

For those who want to customize the code, configure advanced features, integrate unique models, or host a self-managed AiAgentNexus instance, follow the instructions below.


Local Development

Requirements:

  • Ensure Node.js and npm are installed on your machine.

Setup Instructions:

  1. Clone the AiAgentNexus repository:

    git clone https://github.com/ErnestikX/AiAgentNexus.git
    cd AiAgentNexus
  2. Install the required dependencies:

    npm install
  3. Start the development server:

    npm run dev

    Access the application locally at http://localhost:3000.


Local Production Build

To maximize performance, you can run AiAgentNexus in production mode.

  1. Complete Steps 1 and 2 from the Local Development section.

  2. Build the production version of the application:

    npm run build
  3. Start the production server:

    npx next start --port 3000

    Access the production instance at http://localhost:3000.


Advanced Customization

For tasks such as enabling specific AI models, customizing the interface, adding user authentication, or modifying the backend code, refer to the Customization Guide.


☁️ Cloud Deployment Options

Deploy AiAgentNexus on public servers using the following cloud platforms:


Deploy on Vercel

Easily deploy AiAgentNexus on Vercel for fast and reliable hosting.

  • Create a GitHub fork of the repository.

  • Set up a new Vercel project linked to your forked repository.

  • Deploy with just a few clicks.

Alternatively, use the one-click deploy button (if available).


Deploy on Cloudflare

Install AiAgentNexus on Cloudflare Pages to take advantage of a global edge network.

Refer to the Cloudflare Installation Guide for step-by-step instructions.


Docker Deployment

Use Docker to deploy AiAgentNexus for portability and scalability.

Quick Steps:

  1. Optional: Build the Docker image (if not using the pre-built images):

    docker build -t AiAgentNexus .
  2. Run the container:

    # Option A: Using a self-built image
    docker run -d -p 3000:3000 AiAgentNexus
    
    # Option B: Using the pre-built image
    docker run -d -p 3000:3000 ghcr.io/ErnestikX/AiAgentNexus
    
    # Option C: Using docker-compose
    docker-compose up

    Access the application at http://localhost:3000.

If deploying behind a reverse proxy, refer to the Reverse Proxy Configuration Guide.


Kubernetes Deployment

Deploy AiAgentNexus on a Kubernetes cluster for enhanced scalability and management.

  1. Clone the repository:

    git clone https://github.com/ErnestikX/AiAgentNexus.git
    cd AiAgentNexus
  2. Configure environment variables:

    cp docs/k8s/env-secret.yaml env-secret.yaml
    vim env-secret.yaml  # Edit the file to set required variables
  3. Deploy the Kubernetes resources:

    kubectl create namespace ns-AiAgentNexus
    kubectl apply -f docs/k8s/AiAgentNexus-deployment.yaml -f env-secret.yaml
  4. Verify the deployment:

    kubectl -n ns-AiAgentNexus get svc,pod,deployment
  5. Access the application:

    kubectl -n ns-AiAgentNexus port-forward service/svc-AiAgentNexus 3000:3000

    Visit http://localhost:3000 in your browser.

For more detailed instructions, refer to the Kubernetes Deployment Guide.


Midori AI Subsystem for Docker

To set up AiAgentNexus with the Midori AI Subsystem, refer to the Midori AI Subsystem Manager for host OS setup. Follow the integration steps for connecting AiAgentNexus to Midori's Docker backend.

Last updated