Getting Started

This guide will walk you through installing Blimp and using it to run one of your docker-compose.yaml files. If you don’t have a docker-compose.yaml file you’d like to use, try one of our examples.

Quickstart

Step 0: Get a docker-compose.yaml

Open the terminal and navigate to the directory containing your docker-compose.yaml.

If you don’t have one, try one of the examples.

Step 1: Install Blimp

curl -fsSL 'https://kelda.io/get-blimp.sh' | sh

Or, we’re also on Homebrew:

brew install kelda/tools/blimp

Step 2: Login

blimp login

Step 3: Boot your docker-compose.yaml

blimp up

If you’re running on Windows, check out the Windows guide.

Explore

In this section, we explore a few things you can do with Blimp now that you’ve got your docker compose file running. For more detailed documentation, see usage.

Check the status of your environment

$ blimp ps
SERVICE	STATUS
mongo    Running
web      Running

Access ports over localhost

Just as you can with Docker Compose, Kelda Blimp allows you to use your browser to access services. For instance, if you were running the Node Todo example you could view the Todo website using the following command.

$ curl http://localhost:8080
<html> ... </html>

View logs

blimp logs web

Get a shell

blimp ssh web

Code with any editor.

Any bind volumes that your docker-compose file mounts will be automatically synchronized using Syncthing. Edit your code locally and changes automatically propagate into the containers.