This guide is for testing and evaluation purposes only and is not intended for production deployments. Please reach out to us at [email protected] if you’d like to learn how to set up OpenOps in a production environment.
This guide explains how to install the OpenOps Docker Compose release on a newly created Azure VM.You’ll need relevant permissions to create a new VM, edit its networking settings, and set up required permissions for Cloud Shell.
Name your machine and select the latest Ubuntu Server as the image. Choose a size with at least 2 CPUs and 8 GB of RAM. Other settings can be left as default.
Click Review + create at the bottom, then Create to create the machine. You will be asked to download the private key.
You may see a warning about leaving port 22 (SSH) open. For production use, it’s recommended to open this port only to relevant IPs, depending on your network configuration. In this guide, we’re using CloudShell to connect to the machine, so the port needs to remain open.
Once the VM deployment is complete, click Go to resource.
From the deployment overview, navigate to Networking > Network settings.
Under Rules, click Create port rule, then select Inbound port rule:
In security rule settings:
Enter 80 in the Destination port ranges text field.
Using the Source dropdown, choose to open the port to everyone (default), to your personal IP address only, or to a preferred range.
Edit the application URL to use the machine’s public IP address:
Copy
Ask AI
sed -i 's/http:\/\/localhost/http:\/\/'$(wget -4qO - https://ifconfig.io/ip)'/g' .env
Open the .env file in the OpenOps installation folder. Change the values of the following variables that represent credentials. Do it now, as you won’t be able to change these values after the initial deployment:
OPS_OPENOPS_ADMIN_EMAIL: the email of your OpenOps installation’s root admin account.
OPS_OPENOPS_ADMIN_PASSWORD: the password of your OpenOps installation’s root admin account.
OPS_POSTGRES_USERNAME: the username of the Postgres database that OpenOps uses.
OPS_POSTGRES_PASSWORD: the password of the Postgres database that OpenOps uses.
OPS_ANALYTICS_ADMIN_PASSWORD: the password of the OpenOps Analytics admin account (the username is hardcoded to admin).
Install Docker using Snap:
Copy
Ask AI
sudo snap install docker
Pull the images and run the Docker containers (rerun the pull command if you encounter a rate limit):
For production usage, it’s recommended to enable TLS (HTTPS). In addition to the security aspect, this also ensures that workflow templates load properly in all browsers.
The easiest way to enable TLS is to use an OpenOps script that requests and sets up a TLS certificate from Let’s Encrypt. Before running the script, make sure you have a domain name that points to your ‘s external IP address. If you’re configuring DNS right before running the script, you may need to wait for the DNS change to propagate.
Run the following command in your terminal:
Copy
Ask AI
curl -fsS https://openops.sh/tls | sh
When prompted, enter a domain name that points to the external IP address of your .
When prompted, enter an email address to receive certificate-related notifications from Let’s Encrypt.
The script will use the Certbot library to request a certificate for your domain from Let’s Encrypt. It receives and saves the certificate, updates the OpenOps configuration file accordingly, and restarts OpenOps.By default, the certificate expires in 3 months. See https://certbot.org/renewal-setup if you want to configure auto-renewal.
Alternatively, you can create a TLS certificate yourself. This lets you use DNS validation from Let’s Encrypt (rather than the HTTP validation the automatic script performs) or request a certificate from a different provider.To set up TLS manually:
Obtain certificate and private key files from your certificate provider.
Upload the certificate files to your OpenOps installation under the tls directory:
By default, OpenOps does not allow workflows to call internal network addresses such as 127.0.0.1 or 192.168.0.0. This affects HTTP and SMTP actions, as well as webhook triggers. Host validation protects users from creating workflows that could accidentally or maliciously access internal services, scan networks, or escalate privileges.You may need to disable this check in certain circumstances, such as in non-production deployments or when workflows intentionally interact with internal-only infrastructure.To disable host validation, open the .env file in your installation folder and set the OPS_ENABLE_HOST_VALIDATION environment variable to false.After making any changes to the .env file, restart the OpenOps containers:
Copy
Ask AI
sudo docker compose downsudo docker compose up -d
Disabling this check removes an important safety guard and may allow workflows to access internal infrastructure. Use caution and avoid disabling it in production.