From a0dac3b693cd5ee59a8c92ae1e0843a8f83206d2 Mon Sep 17 00:00:00 2001 From: Isaiah Fisher Date: Thu, 26 Feb 2026 13:50:00 +0200 Subject: [PATCH 1/3] Revise README for .env file setup instructions Updated README to include instructions for creating a .env config file and clarified usage of the start.sh script. --- README.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 398492270..288c3fc54 100644 --- a/README.md +++ b/README.md @@ -87,10 +87,9 @@ git clone https://github.com/pneumaticapp/pneumaticworkflow.git ``` or, you can simply download the [project's master folder](https://github.com/pneumaticapp/pneumaticworkflow/archive/refs/heads/master.zip) and unzip it -### Edit the configuration files if necessary +### Create a .env config file - -If you want to be accessing Pneumatic over the Internet and the machine you plan to be running it on has an external IP address/domain name, all you need to do is create an .env file in the root directory of the project (touch .env) and add these lines to it: +Cd into the project's directory and run the ```./start.sh``` script, passing it the address of your server as the sole argument(```./start.sh your-address```). If no argument is passed the script will use localhost as the default address and create a .env file setting the following parameters:
   # Without SSL
@@ -103,7 +102,6 @@ If you want to be accessing Pneumatic over the Internet and the machine you plan
   WSS_URL=ws://your-address:8001
 
-save the .env file and you're good to go. ### Run Pneumatic From ce96c9d65ac7aca9b8b55b0b1e7d061fca4e0073 Mon Sep 17 00:00:00 2001 From: Isaiah Fisher Date: Thu, 26 Feb 2026 14:12:35 +0200 Subject: [PATCH 2/3] Update instructions for starting the project Added chmod command to README for start.sh script. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 288c3fc54..43735b29e 100644 --- a/README.md +++ b/README.md @@ -89,7 +89,7 @@ or, you can simply download the [project's master folder](https://github.com/pne ### Create a .env config file -Cd into the project's directory and run the ```./start.sh``` script, passing it the address of your server as the sole argument(```./start.sh your-address```). If no argument is passed the script will use localhost as the default address and create a .env file setting the following parameters: +Cd into the project's directory, run ```chmod +x start.sh```, and then run the ```./start.sh``` script, passing it the address of your server as the sole argument(```./start.sh your-address```). If no argument is passed the script will use localhost as the default address and create a .env file setting the following parameters:
   # Without SSL

From 207a9bdc2a81db9fe97d01b7b8a2b94f8e3c3b81 Mon Sep 17 00:00:00 2001
From: Isaiah Fisher 
Date: Thu, 26 Feb 2026 14:15:05 +0200
Subject: [PATCH 3/3] Update README.md

---
 README.md | 12 +++---------
 1 file changed, 3 insertions(+), 9 deletions(-)

diff --git a/README.md b/README.md
index 43735b29e..16074f481 100644
--- a/README.md
+++ b/README.md
@@ -87,7 +87,7 @@ git clone https://github.com/pneumaticapp/pneumaticworkflow.git
 ```
 or, you can simply download the [project's master folder](https://github.com/pneumaticapp/pneumaticworkflow/archive/refs/heads/master.zip) and unzip it
 
-### Create a .env config file
+### Automatically create a .env config file and run
 
 Cd into the project's directory, run ```chmod +x start.sh```, and then run the ```./start.sh``` script, passing it the address of your server as the sole argument(```./start.sh your-address```). If no argument is passed the script will use localhost as the default address and create a .env file setting the following parameters:
 
@@ -102,17 +102,11 @@ Cd into the project's directory, run ```chmod +x start.sh```, and then run the `
   WSS_URL=ws://your-address:8001
 
+The script will then proceed to run ```docker compose up -d ``` -### Run Pneumatic - -To run Pneumatic cd into the project's directory and run the command - -``` -docker compose up -d -``` This will run it in detached mode, if you want to see what's happening omit the -d flag. -Alternatively, you can run the Pneumatic containers from Docker Desktop. +Alternatively, you can create a .env file with the required parameters manually and run pneumatic either in terminal by executing the ```docker compose up -d``` command in your project's directory or from docker desktop. Note, that the way it's currently configured, Pneumatic's frontend takes a while to get up and running. But you can almost immediately check that your backend is up by going to `http://your-address:8001/admin`