Skip to main content

Installation of Keploy Server

Overview​

The Keploy Server is an API-Testing platform that performs the operations of comparing, storing, deduplication of test-cases. It is completely open source and can be run in a variety of cloud or on-premise environments. A single Server instance can be used for many different use cases simultaneously, or be tied to a single application.

Installation​

There are two ways to quickly install and run the Keploy Server:

  • Docker: Using docker-compose is recommended for individual developers to record, maintain and test locally.
  • Helm Charts: Deploying the Server to Kubernetes is an easy way to improve collaboration amongst test QAs, SDEs, SDETs.

We do not recommend using any of these methods in a full (production) environment.

Docker​

Prerequisites​

  1. Install Docker
  2. Install docker-compose

Start keploy server locally​

git clone https://github.com/keploy/keploy.git && cd keploy

Now start the Keploy server.

docker-compose up

Voilà! 🧑🏻‍💻 We have the server running!

Now open the Keploy Console at http://localhost:8081

Update Keploy Server​

If you're running old version of Keploy. Update the Keploy Server version by pulling the latest docker image.

docker-compose pull

Helm Charts [WIP]​

We're adding the helm chart for hosting Keploy server in a variety of cloud or on-premise environments. Please track the issue here.