AIML Docs

Deploy an AIML Server

Learn how to deploy your own AIML server for running AIML agents

Deploy an AIML Server

This guide will walk you through deploying your own AIML server to run AIML agents in your infrastructure.

Prerequisites

Before you begin, you'll need:

Local Deployment

  1. Clone the repository:

    git clone https://github.com/fw-ai-external/aiml.git
    cd aiml
  2. Install dependencies:

    bun install --filter '!aiml-ui' --filter '!landing-page' --filter '!vscode'
  3. Create a .env file in the apps/server directory:

    cp apps/server/.env.example apps/server/.env
  4. Edit the .env file with your Fireworks API key and database URL:

    DATABASE_URL=postgresql://username:password@hostname:port/database
  5. Run the server:

    cd apps/server
    bun run build
    bun run initial-setup
    bun run start

The server will be available at http://localhost:3000 by default.

Health Monitoring

The AIML server provides health endpoints:

  • /health: Basic health check

You can use these endpoints with monitoring tools like Prometheus, Datadog, or cloud provider monitoring services.

On this page