Add Activepieces integration for workflow automation
- Add Activepieces fork with SmoothSchedule custom piece - Create integrations app with Activepieces service layer - Add embed token endpoint for iframe integration - Create Automations page with embedded workflow builder - Add sidebar visibility fix for embed mode - Add list inactive customers endpoint to Public API - Include SmoothSchedule triggers: event created/updated/cancelled - Include SmoothSchedule actions: create/update/cancel events, list resources/services/customers 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This commit is contained in:
poduck
139
activepieces-fork/docs/install/options/aws.mdx
Normal file
139
activepieces-fork/docs/install/options/aws.mdx
Normal file
@@ -0,0 +1,139 @@
|
||||
---
|
||||
title: "AWS (Pulumi)"
|
||||
description: "Get Activepieces up & running on AWS with Pulumi for IaC"
|
||||
---
|
||||
|
||||
# Infrastructure-as-Code (IaC) with Pulumi
|
||||
|
||||
Pulumi is an IaC solution akin to Terraform or CloudFormation that lets you deploy & manage your infrastructure using popular programming languages e.g. Typescipt (which we'll use), C#, Go etc.
|
||||
|
||||
## Deploy from Pulumi Cloud
|
||||
|
||||
If you're already familiar with Pulumi Cloud and have [integrated their services with your AWS account](https://www.pulumi.com/docs/pulumi-cloud/deployments/oidc/aws/#configuring-openid-connect-for-aws), you can use the button below to deploy Activepieces in a few clicks.
|
||||
The template will deploy the latest Activepieces image that's available on [Docker Hub](https://hub.docker.com/r/activepieces/activepieces).
|
||||
|
||||
[](https://app.pulumi.com/new?template=https://github.com/activepieces/activepieces/tree/main/deploy/pulumi)
|
||||
|
||||
## Deploy from a local environment
|
||||
|
||||
Or, if you're currently using an S3 bucket to maintain your Pulumi state, you can scaffold and deploy Activepieces direct from Docker Hub using the template below in just few commands:
|
||||
|
||||
```bash
|
||||
$ mkdir deploy-activepieces && cd deploy-activepieces
|
||||
$ pulumi new https://github.com/activepieces/activepieces/tree/main/deploy/pulumi
|
||||
$ pulumi up
|
||||
```
|
||||
|
||||
## What's Deployed?
|
||||
|
||||
The template is setup to be somewhat flexible, supporting what could be a development or more production-ready configuration.
|
||||
The configuration options that are presented during stack configuration will allow you to optionally add any or all of:
|
||||
|
||||
* PostgreSQL RDS instance. Opting out of this will use a local SQLite3 Db.
|
||||
* Single node Redis 7 cluster. Opting out of this will mean using an in-memory cache.
|
||||
* Fully qualified domain name with SSL. Note that the hosted zone must already be configured in Route 53.
|
||||
Opting out of this will mean relying on using the application load balancer's url over standard HTTP to access your Activepieces deployment.
|
||||
|
||||
For a full list of all the currently available configuration options, take a look at the [Activepieces Pulumi template file on GitHub](https://github.com/activepieces/activepieces/tree/main/deploy/pulumi/Pulumi.yaml).
|
||||
|
||||
## Setting up Pulumi for the first time
|
||||
|
||||
If you're new to Pulumi then read on to get your local dev environment setup to be able to deploy Activepieces.
|
||||
|
||||
### Prerequisites
|
||||
|
||||
1. Make sure you have [Node](https://nodejs.org/en/download) and [Pulumi](https://www.pulumi.com/docs/install/) installed.
|
||||
2. [Install and configure the AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html).
|
||||
3. [Install and configure Pulumi](https://www.pulumi.com/docs/clouds/aws/get-started/begin/).
|
||||
4. Create an S3 bucket which we'll use to maintain the state of all the various service we'll provision for our Activepieces deployment:
|
||||
|
||||
```bash
|
||||
aws s3api create-bucket --bucket pulumi-state --region us-east-1
|
||||
```
|
||||
|
||||
<Tip>
|
||||
Note: [Pulumi supports to two different state management approaches](https://www.pulumi.com/docs/concepts/state/#deciding-on-a-state-backend).
|
||||
If you'd rather use Pulumi Cloud instead of S3 then feel free to skip this step and setup an account with Pulumi.
|
||||
</Tip>
|
||||
|
||||
5. Login to the Pulumi backend:
|
||||
|
||||
```bash
|
||||
pulumi login s3://pulumi-state?region=us-east-1
|
||||
```
|
||||
6. Next we're going to use the Activepieces Pulumi deploy template to create a new project, a stack in that project and then kick off the deploy:
|
||||
|
||||
```bash
|
||||
$ mkdir deploy-activepieces && cd deploy-activepieces
|
||||
$ pulumi new https://github.com/activepieces/activepieces/tree/main/deploy/pulumi
|
||||
```
|
||||
|
||||
This step will prompt you to create you stack and to populate a series of config options, such as whether or not to provision a PostgreSQL RDS instance or use SQLite3.
|
||||
|
||||
<Tip>
|
||||
Note: When choosing a stack name, use something descriptive like `activepieces-dev`, `ap-prod` etc.
|
||||
This solution uses the stack name as a prefix for every AWS service created
|
||||
e.g. your VPC will be named `<stack name>-vpc`.
|
||||
</Tip>
|
||||
|
||||
7. Nothing left to do now but kick off the deploy:
|
||||
|
||||
```bash
|
||||
pulumi up
|
||||
```
|
||||
|
||||
8. Now choose `yes` when prompted. Once the deployment has finished, you should see a bunch of Pulumi output variables that look like the following:
|
||||
```json
|
||||
_: {
|
||||
activePiecesUrl: "http://<alb name & id>.us-east-1.elb.amazonaws.com"
|
||||
activepiecesEnv: [
|
||||
. . . .
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
The config value of interest here is the `activePiecesUrl` as that is the URL for our Activepieces deployment.
|
||||
If you chose to add a fully qualified domain during your stack configuration, that will be displayed here.
|
||||
Otherwise you'll see the URL to the application load balancer. And that's it.
|
||||
|
||||
Congratulations! You have successfully deployed Activepieces to AWS.
|
||||
|
||||
## Deploy a locally built Activepieces Docker image
|
||||
|
||||
To deploy a locally built image instead of using the official Docker Hub image, read on.
|
||||
|
||||
1. Clone the Activepieces repo locally:
|
||||
|
||||
```bash
|
||||
git clone https://github.com/activepieces/activepieces
|
||||
```
|
||||
2. Move into the `deploy/pulumi` folder & install the necessary npm packages:
|
||||
|
||||
```bash
|
||||
cd deploy/pulumi && npm i
|
||||
```
|
||||
3. This folder already has two Pulumi stack configuration files reday to go: `Pulumi.activepieces-dev.yaml` and `Pulumi.activepieces-prod.yaml`.
|
||||
These files already contain all the configurations we need to create our environments. Feel free to have a look & edit the values as you see fit.
|
||||
Lets continue by creating a development stack that uses the existing `Pulumi.activepieces-dev.yaml` file & kick off the deploy.
|
||||
|
||||
```bash
|
||||
pulumi stack init activepieces-dev && pulumi up
|
||||
```
|
||||
|
||||
<Tip>
|
||||
Note: Using `activepieces-dev` or `activepieces-prod` for the `pulumi stack init` command is required here as the stack name needs to match the existing stack file name in the folder.
|
||||
</Tip>
|
||||
|
||||
4. You should now see a preview in the terminal of all the services that will be provisioned, before you continue.
|
||||
Once you choose `yes`, a new image will be built based on the `Dockerfile` in the root of the solution (make sure Docker Desktop is running) and then pushed up to a new ECR, along with provisioning all the other AWS services for the stack.
|
||||
|
||||
Congratulations! You have successfully deployed Activepieces into AWS using a locally built Docker image.
|
||||
|
||||
## Customising the deploy
|
||||
|
||||
All of the current configuration options, as well as the low-level details associated with the provisioned services are fully customisable, as you would expect from any IaC.
|
||||
For example, if you'd like to have three availability zones instead of two for the VPC, use an older version of Redis or add some additional security group rules for PostgreSQL, you can update all of these and more in the `index.ts` file inside the `deploy` folder.
|
||||
|
||||
Or maybe you'd still like to deploy the official Activepieces Docker image instead of a local build, but would like to change some of the services. Simply set the `deployLocalBuild` config option in the stack file to `false` and make whatever changes you'd like to the `index.ts` file.
|
||||
|
||||
Checking out the [Pulumi docs](https://www.pulumi.com/docs/clouds/aws/) before doing so is highly encouraged.
|
||||
122
activepieces-fork/docs/install/options/docker-compose.mdx
Executable file
122
activepieces-fork/docs/install/options/docker-compose.mdx
Executable file
@@ -0,0 +1,122 @@
|
||||
---
|
||||
title: "Docker Compose"
|
||||
description: ""
|
||||
icon: "book"
|
||||
---
|
||||
|
||||
To get up and running quickly with Activepieces, we will use the Activepieces Docker image. Follow these steps:
|
||||
|
||||
## Prerequisites
|
||||
|
||||
You need to have [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) and [Docker](https://docs.docker.com/get-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:
|
||||
|
||||
```bash
|
||||
git clone https://github.com/activepieces/activepieces.git
|
||||
```
|
||||
|
||||
**2. Go to the repository folder.**
|
||||
|
||||
```bash
|
||||
cd activepieces
|
||||
```
|
||||
|
||||
**3.Generate Environment variable**
|
||||
|
||||
Run the following command from the command prompt / terminal
|
||||
|
||||
```bash
|
||||
sh tools/deploy.sh
|
||||
```
|
||||
|
||||
<Tip>
|
||||
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.
|
||||
</Tip>
|
||||
|
||||
**4. Run Activepieces.**
|
||||
|
||||
<Warning>
|
||||
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](https://docs.docker.com/compose/install/) to use Docker Compose.
|
||||
</Warning>
|
||||
|
||||
```bash
|
||||
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:
|
||||
```bash
|
||||
ngrok http 8080
|
||||
```
|
||||
3. Replace `AP_FRONTEND_URL` environment variable in `.env` with the ngrok url.
|
||||
|
||||
|
||||
|
||||
<Warning>
|
||||
When deploying for production, ensure that you update the database credentials and properly set the environment variables.
|
||||
|
||||
Review the [configurations guide](/install/configuration/environment-variables) to make any necessary adjustments.
|
||||
</Warning>
|
||||
|
||||
## Upgrading
|
||||
|
||||
To upgrade to new versions, which are installed using docker compose, perform the following steps. First, open a terminal in the activepieces repository directory and run the following commands.
|
||||
|
||||
### Automatic Pull
|
||||
|
||||
**1. Run the update script**
|
||||
|
||||
```bash
|
||||
sh tools/update.sh
|
||||
```
|
||||
|
||||
### Manually Pull
|
||||
|
||||
**1. Pull the new docker compose file**
|
||||
```bash
|
||||
git pull
|
||||
```
|
||||
|
||||
**2. Pull the new images**
|
||||
```bash
|
||||
docker compose pull
|
||||
```
|
||||
|
||||
**3. Review changelog for breaking changes**
|
||||
|
||||
<Warning>
|
||||
Please review breaking changes in the [changelog](../configuration/breaking-changes).
|
||||
</Warning>
|
||||
|
||||
**4. Run the updated docker images**
|
||||
```
|
||||
docker compose up -d --remove-orphans
|
||||
```
|
||||
|
||||
Congratulations! You have now successfully updated the version.
|
||||
|
||||
## Deleting
|
||||
|
||||
The following command is capable of deleting all Docker containers and associated data, and therefore should be used with caution:
|
||||
|
||||
```
|
||||
sh tools/reset.sh
|
||||
```
|
||||
|
||||
<Warning>
|
||||
Executing this command will result in the removal of all Docker containers and the data stored within them. It is important to be aware of the potentially hazardous nature of this command before proceeding.
|
||||
</Warning>
|
||||
|
||||
|
||||
|
||||
86
activepieces-fork/docs/install/options/docker.mdx
Executable file
86
activepieces-fork/docs/install/options/docker.mdx
Executable file
@@ -0,0 +1,86 @@
|
||||
---
|
||||
title: "Docker"
|
||||
description: "Single docker image deployment with SQLite3 and Memory Queue"
|
||||
icon: "docker"
|
||||
---
|
||||
|
||||
<Warning>
|
||||
This setup is only meant for personal use or testing. It runs on SQLite3 and an in-memory Redis queue, which supports only a single instance on a single machine. For production or multi-instance setups, you must use Docker Compose with PostgreSQL and Redis.
|
||||
</Warning>
|
||||
|
||||
To get up and running quickly with Activepieces, we will use the Activepieces Docker image. Follow these steps:
|
||||
|
||||
## Prerequisites
|
||||
|
||||
You need to have [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) and [Docker](https://docs.docker.com/get-docker/) installed on your machine in order to set up Activepieces via Docker Compose.
|
||||
|
||||
## Install
|
||||
|
||||
### Pull Image and Run Docker image
|
||||
|
||||
Pull the Activepieces Docker image and run the container with the following command:
|
||||
|
||||
```bash
|
||||
docker run -d -p 8080:80 -v ~/.activepieces:/root/.activepieces -e AP_REDIS_TYPE=MEMORY -e AP_DB_TYPE=SQLITE3 -e AP_FRONTEND_URL="http://localhost:8080" activepieces/activepieces:latest
|
||||
```
|
||||
|
||||
### 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:
|
||||
```bash
|
||||
ngrok http 8080
|
||||
```
|
||||
3. Replace `AP_FRONTEND_URL` environment variable in the command line above.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## Upgrade
|
||||
|
||||
Please follow the steps below:
|
||||
|
||||
### Step 1: Back Up Your Data (Recommended)
|
||||
|
||||
Before proceeding with the upgrade, it is always a good practice to back up your Activepieces data to avoid any potential data loss during the update process.
|
||||
|
||||
1. **Stop the Current Activepieces Container:** If your Activepieces container is running, stop it using the following command:
|
||||
```bash
|
||||
docker stop activepieces_container_name
|
||||
```
|
||||
|
||||
2. **Backup Activepieces Data Directory:** By default, Activepieces data is stored in the `~/.activepieces` directory on your host machine. Create a backup of this directory to a safe location using the following command:
|
||||
```bash
|
||||
cp -r ~/.activepieces ~/.activepieces_backup
|
||||
```
|
||||
|
||||
### Step 2: Update the Docker Image
|
||||
|
||||
1. **Pull the Latest Activepieces Docker Image:** Run the following command to pull the latest Activepieces Docker image from Docker Hub:
|
||||
```bash
|
||||
docker pull activepieces/activepieces:latest
|
||||
```
|
||||
|
||||
### Step 3: Remove the Existing Activepieces Container
|
||||
|
||||
1. **Stop and Remove the Current Activepieces Container:** If your Activepieces container is running, stop and remove it using the following commands:
|
||||
```bash
|
||||
docker stop activepieces_container_name
|
||||
docker rm activepieces_container_name
|
||||
```
|
||||
|
||||
### Step 4: Run the Updated Activepieces Container
|
||||
|
||||
Now, run the updated Activepieces container with the latest image using the same command you used during the initial setup. Be sure to replace `activepieces_container_name` with the desired name for your new container.
|
||||
|
||||
```bash
|
||||
docker run -d -p 8080:80 -v ~/.activepieces:/root/.activepieces -e AP_REDIS_TYPE=MEMORY -e AP_DB_TYPE=SQLITE3 -e AP_FRONTEND_URL="http://localhost:8080" --name activepieces_container_name activepieces/activepieces:latest
|
||||
```
|
||||
|
||||
|
||||
Congratulations! You have successfully upgraded your Activepieces Docker deployment
|
||||
15
activepieces-fork/docs/install/options/easypanel.mdx
Executable file
15
activepieces-fork/docs/install/options/easypanel.mdx
Executable file
@@ -0,0 +1,15 @@
|
||||
---
|
||||
title: "Easypanel"
|
||||
description: "Run Activepieces with Easypanel 1-Click Install"
|
||||
---
|
||||
|
||||
Easypanel is a modern server control panel. If you [run Easypanel](https://easypanel.io/docs) on your server, you can deploy Activepieces with 1 click on it.
|
||||
|
||||
<a target="_blank" rel="noopener" href="https://easypanel.io/docs/templates/activepieces"></a>
|
||||
|
||||
## Instructions
|
||||
|
||||
1. Create a VM that runs Ubuntu on your cloud provider.
|
||||
2. Install Easypanel using the instructions from the website.
|
||||
3. Create a new project.
|
||||
4. Install Activepieces using the dedicated template.
|
||||
8
activepieces-fork/docs/install/options/elestio.mdx
Normal file
8
activepieces-fork/docs/install/options/elestio.mdx
Normal file
@@ -0,0 +1,8 @@
|
||||
---
|
||||
title: "Elestio"
|
||||
description: "Run Activepieces with Elestio 1-Click Install"
|
||||
---
|
||||
|
||||
You can deploy Activepieces on Elestio using one-click deployment. Elestio handles version updates, maintenance, security, backups, etc. So go ahead and click below to deploy and start using.
|
||||
|
||||
[](https://elest.io/open-source/activepieces)
|
||||
29
activepieces-fork/docs/install/options/gcp.mdx
Normal file
29
activepieces-fork/docs/install/options/gcp.mdx
Normal file
@@ -0,0 +1,29 @@
|
||||
---
|
||||
title: "GCP"
|
||||
description: ""
|
||||
---
|
||||
|
||||
This documentation is to deploy activepieces on VM Instance or VM Instance Group, we should first create VM template
|
||||
|
||||
## Create VM Template
|
||||
|
||||
First choose machine type (e.g e2-medium)
|
||||
|
||||
After configuring the VM Template, you can proceed to click on "Deploy Container" and specify the following container-specific settings:
|
||||
|
||||
- Image: activepieces/activepieces
|
||||
- Run as a privileged container: true
|
||||
- Environment Variables:
|
||||
- `AP_REDIS_TYPE`: MEMORY
|
||||
- `AP_DB_TYPE`: SQLITE3
|
||||
- `AP_FRONTEND_URL`: http://localhost:80
|
||||
- `AP_EXECUTION_MODE`: SANDBOX_PROCESS
|
||||
- Firewall: Allow HTTP traffic (for testing purposes only)
|
||||
|
||||
Once these details are entered, click on the "Deploy" button and patiently wait for the container deployment process to complete.\
|
||||
|
||||
After a successful deployment, you can access the ActivePieces application by visiting the external IP address of the VM on GCP.
|
||||
|
||||
## Production Deployment
|
||||
|
||||
Please visit [ActivePieces](/install/configuration/environment-variables) for more details on how to customize the application.
|
||||
210
activepieces-fork/docs/install/options/helm.mdx
Normal file
210
activepieces-fork/docs/install/options/helm.mdx
Normal file
@@ -0,0 +1,210 @@
|
||||
---
|
||||
title: 'Helm'
|
||||
description: 'Deploy Activepieces on Kubernetes using Helm'
|
||||
---
|
||||
|
||||
This guide walks you through deploying Activepieces on Kubernetes using the official Helm chart.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- Kubernetes cluster (v1.19+)
|
||||
- Helm 3.x installed
|
||||
- kubectl configured to access your cluster
|
||||
|
||||
## Using External PostgreSQL and Redis
|
||||
|
||||
The Helm chart supports using external PostgreSQL and Redis services instead of deploying the Bitnami subcharts.
|
||||
|
||||
### Using External PostgreSQL
|
||||
|
||||
To use an external PostgreSQL instance:
|
||||
|
||||
```yaml
|
||||
postgresql:
|
||||
enabled: false # Disable Bitnami PostgreSQL subchart
|
||||
host: "your-postgres-host.example.com"
|
||||
port: 5432
|
||||
useSSL: true # Enable SSL if required
|
||||
auth:
|
||||
database: "activepieces"
|
||||
username: "postgres"
|
||||
password: "your-password"
|
||||
# Or use external secret reference:
|
||||
# externalSecret:
|
||||
# name: "postgresql-credentials"
|
||||
# key: "password"
|
||||
```
|
||||
|
||||
Alternatively, you can use a connection URL:
|
||||
|
||||
```yaml
|
||||
postgresql:
|
||||
enabled: false
|
||||
url: "postgresql://user:password@host:5432/database?sslmode=require"
|
||||
```
|
||||
|
||||
### Using External Redis
|
||||
|
||||
To use an external Redis instance:
|
||||
|
||||
```yaml
|
||||
redis:
|
||||
enabled: false # Disable Bitnami Redis subchart
|
||||
host: "your-redis-host.example.com"
|
||||
port: 6379
|
||||
useSSL: false # Enable SSL if required
|
||||
auth:
|
||||
enabled: true
|
||||
password: "your-password"
|
||||
# Or use external secret reference:
|
||||
# externalSecret:
|
||||
# name: "redis-credentials"
|
||||
# key: "password"
|
||||
```
|
||||
|
||||
Alternatively, you can use a connection URL:
|
||||
|
||||
```yaml
|
||||
redis:
|
||||
enabled: false
|
||||
url: "redis://:password@host:6379/0"
|
||||
```
|
||||
|
||||
### External Secret References
|
||||
|
||||
For better security, you can reference passwords from existing Kubernetes secrets (useful with External Secrets Operator or Sealed Secrets):
|
||||
|
||||
```yaml
|
||||
postgresql:
|
||||
enabled: false
|
||||
host: "your-postgres-host.example.com"
|
||||
auth:
|
||||
externalSecret:
|
||||
name: "postgresql-credentials"
|
||||
key: "password"
|
||||
|
||||
redis:
|
||||
enabled: false
|
||||
host: "your-redis-host.example.com"
|
||||
auth:
|
||||
enabled: true
|
||||
externalSecret:
|
||||
name: "redis-credentials"
|
||||
key: "password"
|
||||
```
|
||||
|
||||
## Quick Start
|
||||
|
||||
### 1. Clone the Repository
|
||||
|
||||
```bash
|
||||
git clone https://github.com/activepieces/activepieces.git
|
||||
cd activepieces
|
||||
```
|
||||
|
||||
### 2. Install Dependencies
|
||||
|
||||
```bash
|
||||
helm dependency update
|
||||
```
|
||||
|
||||
### 3. Create a Values File
|
||||
|
||||
Create a `my-values.yaml` file with your configuration. You can use the [example values file](https://github.com/activepieces/activepieces/blob/main/deploy/activepieces-helm/values.yaml) as a reference.
|
||||
The Helm chart has sensible defaults for required values while leaving the optional ones empty, but you should customize these core values for production
|
||||
|
||||
|
||||
### 4. Install Activepieces
|
||||
|
||||
```bash
|
||||
helm install activepieces deploy/activepieces-helm -f my-values.yaml
|
||||
```
|
||||
|
||||
### 5. Verify Installation
|
||||
|
||||
```bash
|
||||
# Check deployment status
|
||||
kubectl get pods
|
||||
kubectl get services
|
||||
|
||||
```
|
||||
|
||||
## Production Checklist
|
||||
|
||||
- [ ] Set `frontendUrl` to your actual domain
|
||||
- [ ] Set strong passwords for PostgreSQL and Redis (or keep auto-generated)
|
||||
- [ ] Configure proper ingress with TLS
|
||||
- [ ] Set appropriate resource limits
|
||||
- [ ] Configure persistent storage
|
||||
- [ ] Choose appropriate [execution mode](/install/architecture/workers) for your security requirements
|
||||
- [ ] Review [environment variables](/install/configuration/environment-variables) for advanced configuration
|
||||
- [ ] Consider using a [separate workers](/install/guides/separate-workers) setup for better availability and security
|
||||
|
||||
## Upgrading
|
||||
|
||||
```bash
|
||||
# Update dependencies
|
||||
helm dependency update
|
||||
|
||||
# Upgrade release
|
||||
helm upgrade activepieces deploy/activepieces-helm -f my-values.yaml
|
||||
|
||||
# Check upgrade status
|
||||
kubectl rollout status deployment/activepieces
|
||||
```
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Common Issues
|
||||
|
||||
1. **Pod won't start**: Check logs with `kubectl logs deployment/activepieces`
|
||||
2. **Database connection**: Verify PostgreSQL credentials and connectivity
|
||||
3. **Frontend URL**: Ensure `frontendUrl` is accessible from external sources
|
||||
4. **Webhooks not working**: Check ingress configuration and DNS resolution
|
||||
|
||||
### Useful Commands
|
||||
|
||||
```bash
|
||||
# View logs
|
||||
kubectl logs deployment/activepieces -f
|
||||
|
||||
# Port forward for testing
|
||||
kubectl port-forward svc/activepieces 4200:80 --namespace default
|
||||
|
||||
# Get all resources
|
||||
kubectl get all --namespace default
|
||||
```
|
||||
|
||||
## Editions
|
||||
|
||||
Activepieces supports three editions:
|
||||
|
||||
- **`ce` (Community Edition)**: Open-source version with all core features (default)
|
||||
- **`ee` (Enterprise Edition)**: Self-hosted edition with advanced features like SSO, RBAC, and audit logs
|
||||
- **`cloud`**: For Activepieces Cloud deployments
|
||||
|
||||
Set the edition in your values file:
|
||||
|
||||
```yaml
|
||||
activepieces:
|
||||
edition: "ce" # or "ee" for Enterprise Edition
|
||||
```
|
||||
|
||||
For Enterprise Edition features and licensing, visit [activepieces.com](https://www.activepieces.com/docs/admin-console/overview).
|
||||
|
||||
## Environment Variables
|
||||
|
||||
For a complete list of configuration options, see the [Environment Variables](/install/configuration/environment-variables) documentation. Most environment variables can be configured through the Helm values file under the `activepieces` section.
|
||||
|
||||
## Execution Modes
|
||||
|
||||
Understanding execution modes is crucial for security and performance. See the [Workers & Sandboxing](/install/architecture/workers) guide to choose the right mode for your deployment.
|
||||
|
||||
## Uninstalling
|
||||
|
||||
```bash
|
||||
helm uninstall activepieces
|
||||
|
||||
# Clean up persistent volumes (optional)
|
||||
kubectl delete pvc -l app.kubernetes.io/instance=activepieces
|
||||
```
|
||||
108
activepieces-fork/docs/install/options/railway.mdx
Normal file
108
activepieces-fork/docs/install/options/railway.mdx
Normal file
@@ -0,0 +1,108 @@
|
||||
---
|
||||
title: "Railway"
|
||||
description: "Deploy Activepieces to the cloud in minutes using Railway's one-click template"
|
||||
---
|
||||
|
||||
Railway simplifies your infrastructure stack from servers to observability with a single, scalable, easy-to-use platform. With Railway's one-click deployment, you can get Activepieces up and running in minutes without managing servers, databases, or infrastructure.
|
||||
|
||||
<a href="https://railway.com/deploy/kGEO1J" target="_blank">
|
||||
<img alt="Deploy on Railway" src="https://railway.app/button.svg" />
|
||||
</a>
|
||||
|
||||
## What Gets Deployed
|
||||
|
||||
The Railway template deploys Activepieces with the following components:
|
||||
|
||||
- **Activepieces Application**: The main Activepieces container running the latest version from [Docker Hub](https://hub.docker.com/r/activepieces/activepieces)
|
||||
- **PostgreSQL Database**: Managed PostgreSQL database for storing flows, executions, and application data
|
||||
- **Redis Cache**: Redis instance for job queuing and caching (optional, can use in-memory cache)
|
||||
- **Automatic SSL**: Railway provides automatic HTTPS with SSL certificates
|
||||
- **Custom Domain Support**: Configure your own domain through Railway's dashboard
|
||||
|
||||
## Prerequisites
|
||||
|
||||
Before deploying, ensure you have:
|
||||
|
||||
- A [Railway account](https://railway.app/) (free tier available)
|
||||
- Basic understanding of environment variables (optional, for advanced configuration)
|
||||
|
||||
## Quick Start
|
||||
|
||||
1. **Click the deploy button** above to open Railway's deployment interface
|
||||
2. **Configure environment variables for advanced usage** (see [Configuration](#configuration) below)
|
||||
3. **Deploy** - Railway will automatically provision resources and start your instance
|
||||
|
||||
Once deployed, Railway will provide you with a public URL where your Activepieces instance is accessible.
|
||||
|
||||
## Configuration
|
||||
|
||||
### Environment Variables
|
||||
|
||||
Railway allows you to configure Activepieces through environment variables. You can set these in the Railway dashboard under your project's **Variables** tab.
|
||||
|
||||
#### Execution Mode
|
||||
|
||||
Configure the execution mode for security and performance:
|
||||
See the [Workers & Sandboxing](/install/architecture/workers) documentation for details on each mode.
|
||||
|
||||
#### Other Important Variables
|
||||
|
||||
- `AP_TELEMETRY_ENABLED`: Enable/disable telemetry (default: `false`)
|
||||
|
||||
For a complete list of all available environment variables, see the [Environment Variables](/install/configuration/environment-variables) documentation.
|
||||
|
||||
## Custom Domain Setup
|
||||
|
||||
Railway supports custom domains with automatic SSL:
|
||||
|
||||
1. Go to your Railway project dashboard
|
||||
2. Navigate to **Settings** → **Networking**
|
||||
3. Add your custom domain
|
||||
4. Update `AP_FRONTEND_URL` environment variable to match your custom domain
|
||||
5. Railway will automatically provision SSL certificates
|
||||
|
||||
For more details on SSL configuration, see the [Setup SSL](/install/guides/setup-ssl) guide.
|
||||
|
||||
## Production Considerations
|
||||
|
||||
Before deploying to production, review these important points:
|
||||
|
||||
- [ ] Review [Security Practices](/admin-guide/security/practices) documentation
|
||||
- [ ] Configure `AP_WORKER_CONCURRENCY` based on your workload and hardware resources
|
||||
- [ ] Ensure PostgreSQL backups are configured in Railway
|
||||
- [ ] Consider database scaling options in Railway
|
||||
|
||||
## Observability
|
||||
|
||||
Railway provides built-in observability features for Activepieces. You can view logs and metrics in the Railway dashboard.
|
||||
|
||||
## Upgrading
|
||||
|
||||
To upgrade to a new version of Activepieces on Railway:
|
||||
|
||||
1. Go to your Railway project dashboard
|
||||
2. Navigate to **Deployments**
|
||||
3. Click **Redeploy** on the latest deployment
|
||||
4. Railway will pull the latest Activepieces image and redeploy
|
||||
|
||||
<Warning>
|
||||
Before upgrading, review the [Breaking Changes](/install/configuration/breaking-changes) documentation to ensure compatibility with your flows and configuration.
|
||||
</Warning>
|
||||
|
||||
## Next Steps
|
||||
|
||||
After deploying Activepieces on Railway:
|
||||
|
||||
1. **Access your instance** using the Railway-provided URL
|
||||
2. **Create your first flow** - see [Building Flows](/flows/building-flows)
|
||||
3. **Configure webhooks** - see [Setup App Webhooks](/install/guides/setup-app-webhooks)
|
||||
4. **Explore pieces** - browse available integrations in the piece library
|
||||
|
||||
## Additional Resources
|
||||
|
||||
- [Troubleshooting](/install/troubleshooting/websocket-issues): Troubleshooting guide
|
||||
- [Configuration Guide](/install/configuration/overview): Comprehensive configuration documentation
|
||||
- [Environment Variables](/install/configuration/environment-variables): Complete list of configuration options
|
||||
- [Architecture Overview](/install/architecture/overview): Understand Activepieces architecture
|
||||
- [Railway Documentation](https://docs.railway.app/): Official Railway platform documentation
|
||||
|
||||
Reference in New Issue
Block a user