Portainer Templates logo

Portainer Templates

Activepieces Activepieces

Stack

AutomationAI

Automate your marketing, sales and operations

Configuration

Type
Compose
Platform
linux
Source
Repo

Template by xneo1·Source

Services

activepieces

Configuration

Image
activepieces/activepieces:0.12.2
Ports
38080:80
Env vars
AP_ENGINE_EXECUTABLE_PATH=dist/packages/engine/main.jsAP_API_KEY=superduperlongranDOMpwdAP_ENCRYPTION_KEY=AP_JWT_SECRET=JWT2square_changemeAP_ENVIRONMENT=prodAP_FRONTEND_URL=http://localhost:38080AP_WEBHOOK_TIMEOUT_SECONDS=30AP_TRIGGER_DEFAULT_POLL_INTERVAL=5AP_POSTGRES_DATABASE=activepiecesAP_POSTGRES_HOST=postgresAP_POSTGRES_PORT=5432AP_POSTGRES_USERNAME=postgresAP_POSTGRES_PASSWORD=postgresof_changemeAP_EXECUTION_MODE=UNSANDBOXEDAP_REDIS_HOST=redisAP_REDIS_PORT=6379AP_SANDBOX_RUN_TIME_SECONDS=600AP_TELEMETRY_ENABLED=falseAP_TEMPLATES_SOURCE_URL="https://cloud.activepieces.com/api/v1/flow-templates"
Restart
unless-stopped

Image details

Pulls: 2.1M
User: moabuaboud
Created: Feb 22, 2023
Updated: 1 day ago
Status: active

ap-postgres

Configuration

Image
postgres:14.4
Volumes
/var/lib/postgresql/data : /portainer/Files/AppData/Config/activepieces/postgres_data
Env vars
POSTGRES_DB=activepiecesPOSTGRES_PASSWORD=postgresof_changemePOSTGRES_USER=postgres
Restart
unless-stopped

Image details

Pulls: 11.2B
User: stackbrew
Created: Jun 05, 2014
Updated: 38 minutes ago
Status: active

ap-redis

Configuration

Image
redis:7.0.7
Volumes
/data : /portainer/Files/AppData/Config/activepieces/redis_data
Restart
unless-stopped

Image details

Pulls: 11.1B
User: stackbrew
Created: Jun 05, 2014
Updated: 9 days ago
Status: active

Standalone Install

Select an install method, to see config/commands for deploying Activepieces

Installation method

Install on Portainer

Import all app templates into your Portainer instance, for easy 1-click deploys

  1. Ensure both Docker and Portainer are installed, and up-to-date
  2. Log into your Portainer web UI
  3. Under Settings → App Templates, paste the below URL
  4. Head to Home → App Templates, and the list of apps will show up
  5. Select Activepieces, fill in any config options, and hit Deploy

Template Import URL

https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
Show Me demo
Original stackfile

The compose file this template deploys, straight from its repo:

services:
  activepieces:
    image: activepieces/activepieces:0.12.2
    container_name: activepieces
    restart: unless-stopped
    ## Enable the following line if you already use AP_EXECUTION_MODE with SANDBOXED or old activepieces, checking the breaking change documentation for more info.
    ## privileged: true
    ports:
      - 38080:80
    depends_on:
      - ap-postgres
      - ap-redis
    environment:
    ## It's advisable to consult the documentation and use the tools/deploy.sh to generate the passwords, keys, instead of manually filling them.
      - AP_ENGINE_EXECUTABLE_PATH=dist/packages/engine/main.js
     ## Random Long Password (Optional for community edition)
      - AP_API_KEY=superduperlongranDOMpwd
     ## 256 bit encryption key, 32 hex character
      - AP_ENCRYPTION_KEY= 
      ## JWT Secret
      - AP_JWT_SECRET=JWT2square_changeme
      - AP_ENVIRONMENT=prod
      - AP_FRONTEND_URL=http://localhost:38080
      - AP_WEBHOOK_TIMEOUT_SECONDS=30
      - AP_TRIGGER_DEFAULT_POLL_INTERVAL=5
      - AP_POSTGRES_DATABASE=activepieces
      - AP_POSTGRES_HOST=postgres
      - AP_POSTGRES_PORT=5432
      - AP_POSTGRES_USERNAME=postgres
      - AP_POSTGRES_PASSWORD=postgresof_changeme
      - AP_EXECUTION_MODE=UNSANDBOXED
      - AP_REDIS_HOST=redis
      - AP_REDIS_PORT=6379
      - AP_SANDBOX_RUN_TIME_SECONDS=600
      - AP_TELEMETRY_ENABLED=false
      - AP_TEMPLATES_SOURCE_URL="https://cloud.activepieces.com/api/v1/flow-templates"
  ap-postgres:
    image: postgres:14.4
    container_name: postgres
    restart: unless-stopped
    environment:
      - POSTGRES_DB=activepieces
      - POSTGRES_PASSWORD=postgresof_changeme
      - POSTGRES_USER=postgres
    volumes:
      - /portainer/Files/AppData/Config/activepieces/postgres_data:/var/lib/postgresql/data
  ap-redis:
    image: redis:7.0.7
    container_name: redis
    restart: unless-stopped
    volumes:
      - /portainer/Files/AppData/Config/activepieces/redis_data:/data

Or deploy it directly from the source:

git clone https://github.com/xneo1/portainer_templates
cd portainer_templates
docker compose -f Template/Stack/activepieces.yml up -d

More install options in our documentation.

Container Documentation

activepieces Documentation

Activepieces is an open-source business automation tool

ap-postgres Documentation

The PostgreSQL object-relational database system provides reliability and data integrity.

ap-redis Documentation

Redis is the world’s fastest data platform for caching, vector search, and NoSQL databases.

Serve Activepieces on your own domain behind Caddy, Nginx or Traefik. Fill in your domain and copy the result. It's a starting point, some apps need their own base URL or extra headers set too.

Proxying activepieces.example.com to http://activepieces:80

Add this to your Caddyfile

activepieces.example.com {
	reverse_proxy http://activepieces:80
}

Check the logs first

Nine times out of ten the logs tell you exactly what went wrong.

  • In Portainer, go to Containers, click the container, then Logs. Or run docker logs <container>
  • Exit codes help too: 137 means killed, usually out of memory. 126 or 127 means the command inside the image is broken.

Port already in use

If deployment fails with "Bind for 0.0.0.0:38080 failed: port is already allocated", something else on your server is using that port.

  • Find what's using it: sudo ss -tlnp | grep :38080
  • Stop the other service, or pick a different host port. In 38080:80 only the left number is yours to change, the right one belongs to the app.

Running but the page won't load

The container is up but nothing appears in your browser.

  • Use your server's real IP: http://your-server-ip:38080. The 0.0.0.0 link Portainer shows isn't a real address.
  • Give it a minute after first deploy, activepieces can take a while to initialise.
  • Make sure your firewall allows the port, e.g. sudo ufw allow 38080

Permission denied on volumes

If the logs show "permission denied", the app can't write to its data folder on the host.

  • Fix the ownership: sudo chown -R 1000:1000 /portainer/Files/AppData/Config/activepieces/postgres_data (and the same for the other mapped folders)

Image won't pull

Test the pull directly on the host: docker pull activepieces/activepieces:0.12.2

  • "manifest unknown" means the tag no longer exists.
  • "toomanyrequests" is the Docker Hub rate limit. Log in with docker login to raise it.
  • "no space left on device" means a full disk. Reclaim space with docker system prune

"exec format error"

This means the image was built for a different CPU architecture than your server.

  • Check yours with uname -m: x86_64 is amd64, aarch64 is arm64. Raspberry Pi and other ARM boards are the usual culprits.

Container keeps restarting

The unless-stopped restart policy relaunches the app after every crash, so the real error can scroll past.

  • Check the logs right after a restart, the last few lines before it died are the useful ones.
  • Get the exit code with docker inspect <container> --format '{{.State.ExitCode}}'
  • Still stuck? Redeploy once with the restart policy set to no so the failure stays visible.

Required settings are blank

AP_ENCRYPTION_KEY has no default value, and activepieces may crash or misbehave if left empty.

  • Fill it in on the deploy screen before hitting deploy.

Stack won't deploy

Compose stacks fail fast on small mistakes, and Portainer shows the reason just above the editor.

  • YAML only accepts spaces for indentation, a single tab breaks the whole file.

Raise an issue

Found something which isn't working as it should? Here's how to report it.

A Compose stack

Activepieces is a Compose stack, a set of containers (3 of them) defined in one file and brought up together by Portainer, then started and stopped as a single app.

The services

This stack is built from 3 containers that run side by side. Here's each one, with the image it runs and anything it waits for first:

  • activepieces runs activepieces/activepieces:0.12.2, starts after ap-postgres, ap-redis
  • ap-postgres runs postgres:14.4
  • ap-redis runs redis:7.0.7

Ports

A port is the door the app answers on. A mapping like 38080:80 means it's reachable on port 38080 of your server, where the left number is yours to change and the right one belongs to the app. Once it's running, open http://your-server-ip:38080 in a browser. It opens:

  • 38080:80, likely the web interface

Volumes

A volume is where Activepieces keeps its files so they survive an update or a restart. Without one, anything it saves would sit inside the container and vanish the moment it's recreated. This template mounts:

  • /var/lib/postgresql/data from /portainer/Files/AppData/Config/activepieces/postgres_data on the host
  • /data from /portainer/Files/AppData/Config/activepieces/redis_data on the host

Environment variables

Environment variables are the settings you hand over when you deploy, things like a password or a timezone. Activepieces takes 22 of them, and one needs a value before it'll start properly:

  • AP_ENGINE_EXECUTABLE_PATH, defaults to dist/packages/engine/main.js
  • AP_API_KEY, defaults to superduperlongranDOMpwd
  • AP_ENCRYPTION_KEY, needs a value
  • AP_JWT_SECRET, defaults to JWT2square_changeme
  • AP_ENVIRONMENT, defaults to prod
  • AP_FRONTEND_URL, defaults to http://localhost:38080
  • AP_WEBHOOK_TIMEOUT_SECONDS, defaults to 30
  • AP_TRIGGER_DEFAULT_POLL_INTERVAL, defaults to 5
  • AP_POSTGRES_DATABASE, defaults to activepieces
  • AP_POSTGRES_HOST, defaults to postgres
  • AP_POSTGRES_PORT, defaults to 5432
  • AP_POSTGRES_USERNAME, defaults to postgres
  • AP_POSTGRES_PASSWORD, defaults to postgresof_changeme
  • AP_EXECUTION_MODE, defaults to UNSANDBOXED
  • AP_REDIS_HOST, defaults to redis
  • AP_REDIS_PORT, defaults to 6379
  • AP_SANDBOX_RUN_TIME_SECONDS, defaults to 600
  • AP_TELEMETRY_ENABLED, defaults to false
  • AP_TEMPLATES_SOURCE_URL, defaults to "https://cloud.activepieces.com/api/v1/flow-templates"
  • POSTGRES_DB, defaults to activepieces
  • POSTGRES_PASSWORD, defaults to postgresof_changeme
  • POSTGRES_USER, defaults to postgres

Restart policy

The restart policy here is unless-stopped, so Docker restarts Activepieces after a crash or reboot, but leaves it off when you stop it on purpose. You can change this on the deploy screen. The choices are no (never restart), on-failure (only after a crash), unless-stopped (restart unless you stop it), and always (bring it back no matter what).

Networking

Portainer puts these services on one shared private network, so they can find each other by name (like activepieces) while only the ports above are open to you.

Platform

The platform is linux, the kind of system the container is built to run on. Docker and Portainer handle this on a normal Linux server.

Portainer app templates

Zooming out, this whole page comes from a Portainer app template: a short recipe telling Portainer how to set Activepieces up. Add the template list to Portainer once, then deploying Activepieces is a click rather than a wall of config.