Deploy Yaade - A Postman Alternative

Yaade (Yet Another API Development Environment) is an open-source, self-hosted, collaborative API development environment that I treat as an alternative to Postman and Hoppscotch.

Steps

First of all, lets create a named volume for all of Yaade's data, so that it will persist across containers being added/removed.

docker volume create yaade

Now let's create a BASH script for running Yaade:

# Unfortunately latest and nightly are the only tags right now
# https://hub.docker.com/r/esperotech/yaade/tags
VERSION="latest"

docker run -d \
  --restart=always \
  -p 80:9339 \
  -e YAADE_ADMIN_USERNAME=admin \
  -v yaade:/app/data \
  --name yaade \
  esperotech/yaade:$VERSION

Then just run that.

When you wish to update, you can run the following:

#!/bin/bash
docker pull esperotech/yaade:latest

docker stop yaade || true
docker rm yaade || true

docker run -d \
  --restart=always \
  -p 80:9339 \
  -e YAADE_ADMIN_USERNAME=admin \
  -v yaade:/app/data \
  --name yaade \
  esperotech/yaade:latest

Using Yaade

Default Credentials

You specified the admin username in the Docker run command, so that is your initial user with admin privileges. The default password for all newly created accounts is simply password. Thus use this to log in for the first time and immediately go to the settings and change it.

Whenever you create a new user, remember that the default password will still be password, so I would recommend creating a new private window, logging in as that user, and changing it to a strong temporary password before sending it to whoever you want (there is no SMTP email login flow yet).

Documentation Location

• https://docs.yaade.io/

Creating Groups

At the moment, when one creates a group when creating a user, one has to remember to add a space at the end, in order for the application to recognize the creation of a new group. If you forget to do this, then no group will be created.

No Tagged Versions In Dockerhub (Yet)

Unfortunately, there are no tagged versions of Yaade (yet).

Plugin Only Available For Chrome

Unfortunately there is not yet a Firefox extension, only a Chrome plugin. This means that if you need to send requests to localhost, and yaade is deployed to a server on the internet, you will likely have to use Chrome. Otherwise, you can configure the environment to use the server as a proxy, and the server will send the requests.