Installing ProcessMaker
This guide will instruct you on how to get started with ProcessMaker, from local installs to rapid cloud deployment.
Overview
Install the open-source ProcessMaker Platform using Docker Desktop and Docker Compose. Before proceeding with the installation process, it is essential to have a basic understanding of Linux commands. Familiarity with common command-line operations such as navigating directories, executing commands, and editing files will greatly facilitate the installation process and troubleshooting.
Requirements
Before proceeding with the installation, ensure that you have met the following prerequisites.
Requirement | Function | Version | Installation Guide |
---|---|---|---|
WSL2 or Unix based OS | WSL2 enables access to the command line for installing and accessing containers. | Latest | |
Docker provides the underlying technology to deploy containerized applications. | Latest |
WSL2 (Windows Subsystem for Linux)
If you are using Microsoft Windows, then you can install ProcessMaker within WSL2.
Go to Microsoft's site and follow their instructions. It's very easy and quick.
Docker
Download and install Docker for Desktop.
If you are on Microsoft Windows, ensure to go into settings and enable the WSL2 integration.
Docker Compose
This installation procedure uses Docker Compose. The Docker Compose file is located in this GitHub repository. Issues, PRs and contribution are most welcome!
The Docker Compose File
Ensure you specify which branch or release of the ProcessMaker repository you wish to install and replace ${PROCESSMAKER_CORE_VERSION_INSTALL}
with the desired version.
Open up your terminal for your platform:
Windows: Windows Terminal is a good option. Just make sure you don't go into CMD or PowerShell.
Macs: iTerm is a good option.
Other Unix-based operating systems: The native terminal should be more than adequate.
Oh My Zsh is a wonderful CLI tool that can help you with auto-completion within the terminal and syntax highlighting, convenience methods and much more.
You can find information about installing it here.
The yaml file below is the docker-compose.yaml
file that we are going to use.
The Laravel ENV File
Below is the default configuration parameters for the .env
file (which will be env
if cloning from the repo). You can copy-and-paste the snippet below into a new file. If you are using the repository, it should already be set there.
You may change any settings that you wish. Just make sure that the settings are valid and do not cause errors or issues.
In your terminal, run the following Docker command inside the folder where your Docker Compose file is:
To spin down the environment, run the following Docker command:
If this is your first time installing, it will take time for all the Docker images to download. At the end, you should see a message in your terminal that shows the Laravel Echo server is running and initial jobs should start running.
Did You Know?
The script adds a mounted folder for the ProcessMaker Platform installation and for Scripts, which is basically a good place to stick anything that is not purely ProcessMaker that you need as part of your application. For example, if you are developing a custom package or using Script Executors.
You may access the filesystem from outside the container. Just make sure to run any commands like composer update
within the container (or send the command to it).
Troubleshooting
This section will be updated regularly as new issues and troubleshooting steps become known.
Feedback
If you got all the way down here, congratulations on being thorough! If you could kindly rate this page as helpful or unhelpful, that goes a long way towards improving our content.
Quick Start with Process Templates
Explore our ready-to-go Process Templates to kick-start your automation across several use cases and industries. Deploy into your Platform instance to spin up new processes and use as-is with all necessary assets included.
Last updated