Skip to content

Running Pneumatic Locally

Isaiah Fisher edited this page Dec 24, 2024 · 3 revisions

How to Self-Host Pneumatic on your machine

You can clone the repository and get Pneumatic up and running on your machine, here's how:

Git, Docker and Docker Compose

First of all make sure you have docker version 2.27 or above and docker compose version 27.0 or above installed(to run Pneumatic locally), as well as git version 2.0 or above (to clone the repo).

In theory, the operating system should not matter, but having said that, be aware that as of the time of this writing, Pneumatic's docker compose distro has only been tested in Ubuntu and Mac OS.

Edit the hosts file

Make sure your machine's hosts file has the following lines:

127.0.0.1 localhost

127.0.0.1 api-localhost

127.0.0.1 form-localhost

It probably will already have the first line, but make sure you add 127.0.0.1 api-localhost and 127.0.0.1 form-localhost. You need these to allow Pneumatic's front-end and back-end to talk to each other while running in different containers on your machine.

On a Mac or Linux box, you can open up the hosts file by running the following command:

sudo nano /etc/hosts

On Windows, just search for hosts and open it with NotePad or something.

Add

127.0.0.1 localhost

127.0.0.1 api-localhost

127.0.0.1 form-localhost

To it and save it. (In nano you can press control X and then y - this will save the file and then close it)

Clone the repo

Go into the folder/directory where you want to run Pneumatic from and run the command:

git clone https://github.com/pneumaticapp/pneumaticworkflow.git

This will create a directory named pneumaticworkflow. Cd into it (cd pneumaticworkflow) and run:

docker compose up -d

It can take a while for all the containers to get pulled and built but eventually they'll start at which point...

Open Pneumatic and register an account

Once the containers are up and running go to http://localhost/ in your browser, register a free account and you're good to go.

Known Issues

None as of this writing. Just remember to double check your hosts file

127.0.0.1 localhost

127.0.0.1 api-localhost

127.0.0.1 form-localhost