This guide is for testing and evaluation purposes only and is not intended for production deployments. Please reach out to us at support@openops.com 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.

Initial deployment

Create a new virtual machine

  1. Navigate to Create a virtual machine in Azure. Virtual machines
  2. Name your machine and select the latest Ubuntu Server as the image. Choose a size with at least 2 CPUs and 8GB of RAM. Other settings can be left as default. Instance details
  3. 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.
  4. Once the machine is created, click Go to resource, then navigate to Networking > Network settings and Create port rule > Inbound port rule to set the required destination port to 80. You can open the port to everyone, to your personal IP address only, or to a preferred range. Click Add to create the rule. Creating a port rule Adding an inbound security rule

Connect to the virtual machine with Cloud Shell

  1. Under Overview, select Connect and SSH using Azure CLI to open the Cloud Shell inside Azure Portal. CloudShell overview SSH using Azure CLI SSH using Azure CLI - configure and connect After a quick validation and setup, CloudShell should open and connect to the machine.
  2. Ensure you’re using the Bash shell by running the following command (you may need to paste it using a right-click instead of Ctrl+V):
    [ -z "$BASH_VERSION" ] && exec bash
    

Install OpenOps

Run the following command in your terminal to install, update, configure and run OpenOps:
curl -fsS https://openops.sh/install | sh
Alternatively, you can follow the manual installation steps: You can now access the application by navigating to the public IP address of your virtual machine, for example, http://20.20.20.20.

Getting credentials for Azure connections

See this guide.

Enabling TLS

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.
  1. Run the following command in your terminal:
    curl -fsS https://openops.sh/tls | sh
    
  2. When prompted, enter a domain name that points to the external IP address of your .
  3. 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.

Updating OpenOps to a newer version

See Updating OpenOps.

Support

Feel free to join our Slack community if you have any questions or need help with the installation.