[](https://support.pneumatic.app/en/)
[](LICENSE)
# Pneumatic: All Workflows all the Time
**Pneumatic** is an open-source SaaS workflow management system designed to streamline and organize workflows in businesses of any size. Originally developed as a cloud-based platform, Pneumatic empowers teams by enabling them to set up, run, and optimize workflows collaboratively, tracking each stage as tasks move from team to team.
[:tv: Product Overview (< 5 min)](https://www.youtube.com/watch?v=GC67ocuOFfE)
## Key Features
**Workflow Templates:** Create custom workflow templates and reuse them for repetitive processes. Templates define a series of steps that can be used across multiple workflows.
**Multi-Workflow Management:** Once templates are set, create multiple workflows from each template and run them in parallel, adapting them as needed.
**Task Buckets for Staff:** Pneumatic focuses on individual task management, giving each staff member their own bucket of tasks. Staffers can complete tasks efficiently by emptying their buckets one by one.
**Automated Workflow Tracking:** With automated tracking, Pneumatic provides real-time insight into each workflow’s stage and automates handoffs between teams as tasks progress from step to step.
## Find out more about how Pneumatic works by watching our video presentations:
[:tv: Getting Started with Workflow Templates (< 5 min)](https://youtu.be/sgDbMDyxWoY)
[:tv: Working with Workflows (< 5 min)](https://youtu.be/4FIqPVQrxtI)
[:tv: Working with Tasks (< 5 min)](https://youtu.be/9ZokwLdoVjY)
[:tv: Information Flow via Data Fields (< 5 min)](https://youtu.be/eITtZEciQnk)
## Integrations
As a cloud native solution Pneumatic easily integrates with other SaaS systems, either directly through its public API or via third party integration solutions like Zapier
## Documentation
For more in-depth treatment of Pneumatic's features consult the support center: [Pneumatic Support Center](https://support.pneumatic.app/en/)
## Getting Started
You can grab your own copy of Pneumatic by cloning this repository and self-hosting it on your machine/instance. Here's a quick start guide:
### Prerequisites
* Operating System: Linux(Ubuntu/Debian), macOS or Windows(install and run at your own risk)
* Git (optional, if you want to clone the repository)
* Docker version 2.27 or above
* Docker compose version 27.0 or above
* At least 8GB of RAM (recommended 16GB)
* At least 50GB of diskspace(recommended 100GB)
* Ports 80, 443, and 8001 must be open and not in use by any other process(like apache or nginx)
### Get the files
You can either clone the repository using git like so
```
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
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:
# Without SSL
SERVER_ADDRESS=your-address
BACKEND_URL=http://your-address:8001
FRONTEND_URL=http://your-address
FORMS_URL=http://form.your-address
WSS_URL=ws://your-address:8001
save the .env file and you're good to go.
### 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.
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`
### Open Pneumatic and register a free account
Once the containers are up and running go to http://your-server-address (http://localhost if you're connecting from the same machine) in your browser, register a free account and you're good to go.
### Deploying to Production
Deploying an instance of Pneumatic in production involves such steps as:
- setting up SSL
- setting up SSO
These steps are described in detail in [this wiki article](https://github.com/pneumaticapp/pneumaticworkflow/wiki/Configuration)
## License
This project is licensed under the Apache License, Version 2.0 - see the [LICENSE](LICENSE) file for details.
```markdown
Copyright 2024 Pneumatic Software, Inc.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.