Deployment Guide

Deploy to your Infrastructure

APIKlone ships as a single Docker image and integrates with Google Cloud Storage or local disk out of the box.

Google Cloud Run

Recommended

APIKlone runs natively on Cloud Run — stateless, auto-scaling, and backed by Google Cloud Storage for persistent mock data and configuration.

Deployment Steps

Enable required GCP APIs

gcloud services enable run.googleapis.com \

artifactregistry.googleapis.com \

cloudbuild.googleapis.com \

storage.googleapis.com

Create a Cloud Storage bucket

gcloud storage buckets create gs://YOUR_BUCKET_NAME \

--location=europe-west2 \

--project=YOUR_PROJECT_ID

The bucket holds config.json, mocks/, and contacts/ — all APIKlone state.

Deploy directly from source

sh deploy.sh

This builds the Docker image via Cloud Build, pushes to Artifact Registry, and deploys to Cloud Run automatically. Edit deploy.sh to set your project ID, region, and bucket name.

Grant bucket access

gcloud projects add-iam-policy-binding YOUR_PROJECT_ID \

--member="serviceAccount:YOUR_SA@developer.gserviceaccount.com" \

--role="roles/storage.objectAdmin"

AWS Deployment

Coming Soon

APIKlone can be deployed to AWS using ECS Fargate or App Runner. S3 storage adapter is currently on the roadmap.

AWS App Runner (Simplest)

Push the Docker image to Amazon ECR

# Build and push

docker build -t apiklone .

docker tag apiklone:latest YOUR_ACCOUNT_ID.dkr.ecr.eu-west-1.amazonaws.com/apiklone:latest

docker push YOUR_ACCOUNT_ID.dkr.ecr.eu-west-1.amazonaws.com/apiklone:latest

Create an App Runner service

aws apprunner create-service \

--service-name apiklone \

--source-configuration '{ "ImageRepository": { "ImageIdentifier": "YOUR_IMAGE", "ImageRepositoryType": "ECR" } }'

On-Premise Hosted

Full Control

Run APIKlone on any Linux server or VM with Docker installed. Data is persisted to the local filesystem by default — no cloud credentials needed.

Run with Docker Compose

Create a `docker-compose.yml`

version: "3.9"

services:

apiklone:

image: ghcr.io/YOUR_ORG/apiklone:latest

restart: unless-stopped

ports:

- "3000:3000"

volumes:

- ./data/mocks:/app/mocks

- ./data/contacts:/app/contacts

Start the stack

docker compose up -d

Visit http://YOUR_SERVER_IP:3000 to confirm APIKlone is running.

Get In Touch

Running into deployment issues on Cloud Run? Need an Enterprise license? Drop us a securely delivered line below.