How to Deploy the Gateway?

Managed Deployment by Portkey for quick setup without infrastructure concerns
Local Deployment for complete control & customization
Enterprise Deployment for advanced features and dedicated support

Managed Deployment

Portkey runs this same Gateway on our API and processes billions of tokens daily. Portkey's API is in production with companies like Postman, Haptik, Turing, MultiOn, SiteGPT, and more.

Sign up for the free developer plan (10K request/month) here or discuss here for enterprise deployments.

Check out the API docs here.

Local Deployment

Do NPM or Bun Install
Run a Node.js Server
Deploy on Cloudflare Workers
Deploy using Docker
Deploy using Docker Compose
Deploy on Replit
Deploy on Zeabur

Node

$ npx @portkey-ai/gateway

Bun

$ bunx @portkey-ai/gateway

Cloudflare Workers

Clone the Repository

git clone https://github.com/portkey-ai/gateway

Install the NPM Dependencies

cd gateway
npm install

Deploy (using Wrangler CLI)

npm run deploy

NodeJS Server

Clone the Repository

git clone https://github.com/portkey-ai/gateway

Install the NPM Dependencies

cd gateway
npm i
npm run build

Run the Server

node build/start-server.js

Docker

Run using Docker directly:

docker run -d -p 8787:8787 portkeyai/gateway:latest

For more information on the Docker image, check here

Docker Compose

Download Compose File from the Repository:

wget "https://raw.githubusercontent.com/Portkey-AI/gateway/main/docker-compose.yaml"

Run:

docker compose up -d

The service is now running and listening on port 8787