Skip to main content
To get up and running quickly with Activepieces, we will use the Activepieces Docker image. Follow these steps:

​
Prerequisites

You need to have Git and Docker installed on your machine in order to set up Activepieces via Docker Compose.

​
Installing

1. Clone Activepieces repository. Use the command line to clone Activepieces repository: 
git clone https://github.com/activepieces/activepieces.git
2. Go to the repository folder. 
cd activepieces
3.Generate Environment variable Run the following command from the command prompt / terminal 
sh tools/deploy.sh
If none of the above methods work, you can rename the .env.example file in the root directory to .env and fill in the necessary information within the file.
4. Run Activepieces.
Please note that “docker-compose” (with a dash) is an outdated version of Docker Compose and it will not work properly. We strongly recommend downloading and installing version 2 from the here to use Docker Compose.
docker compose -p activepieces up

​
4. Configure Webhook URL (Important for Triggers, Optional If you have public IP)

Note: By default, Activepieces will try to use your public IP for webhooks. If you are self-hosting on a personal machine, you must configure the frontend URL so that the webhook is accessible from the internet. Optional: The easiest way to expose your webhook URL on localhost is by using a service like ngrok. However, it is not suitable for production use.
  1. Install ngrok
  2. Run the following command:
ngrok http 8080
  1. Replace AP_FRONTEND_URL environment variable in .env with the ngrok url.