Skip to content
Klutch.sh Docs

Deploying Yaade

Introduction

Yaade is a self-hosted, collaborative API development environment similar to Postman and Insomnia. It provides a clean interface for creating, testing, and documenting APIs while keeping all your requests and collections on your own server.

Key highlights of Yaade:

  • Collection Management: Organize requests into collections and folders
  • Environment Variables: Define variables for different environments
  • Team Collaboration: Share collections with team members
  • Request History: Track all sent requests
  • Multiple Auth Types: Support for Basic, Bearer, API Key, and OAuth
  • Response Visualization: Pretty-print JSON, XML, and HTML responses
  • Import/Export: Postman and OpenAPI import support
  • Dark Mode: Easy on the eyes for late-night debugging

This guide walks through deploying Yaade on Klutch.sh using Docker.

Why Deploy Yaade on Klutch.sh

Deploying Yaade on Klutch.sh provides several advantages:

Data Privacy: API requests and credentials stay on your server.

Team Access: Collaborate with team members from anywhere.

HTTPS by Default: Secure access to your API development environment.

No Subscriptions: Free yourself from SaaS pricing tiers.

Prerequisites

Before deploying Yaade on Klutch.sh, ensure you have:

Deploying Yaade on Klutch.sh

    Create Your Repository

    Create a new GitHub repository with a Dockerfile:

    FROM esperotech/yaade:latest
    

    ENV YAADE_ADMIN_USERNAME=${YAADE_ADMIN_USERNAME:-admin}
    

    EXPOSE 9339
    

    CMD ["java", "-jar", "yaade.jar"]

    Push to GitHub

    Push your Dockerfile to your GitHub repository.

    Create a New Project on Klutch.sh

    Navigate to the Klutch.sh dashboard and create a new project.

    Create a New App

    Within your project, create a new app and connect your GitHub repository.

    Configure HTTP Traffic

    Set the traffic type to HTTP with port 9339.

    Set Environment Variables

    Configure the following environment variables:

    VariableValue
    YAADE_ADMIN_USERNAMEYour admin username

    Attach Persistent Volume

    Add a persistent volume mounted at /app/data for your collections and settings.

    Deploy Your Application

    Click Deploy to build and launch Yaade.

    Log In

    Access your Yaade instance. The default password is password - change it immediately after first login.

Additional Resources

Conclusion

Yaade on Klutch.sh provides a powerful, self-hosted API development environment for individuals and teams. Keep your API requests and credentials private while enjoying collaborative features without subscription fees.