This guide explains how to install the OpenOps docker-compose release on a local machine. Note that these settings are for testing purposes only and not for a production environment.Before following the instructions, make sure that your machine meets the system requirements for OpenOps.
Run the following command in your terminal to install, update, configure and run OpenOps:
Copy
Ask AI
curl -fsS https://openops.sh/install | sh
This script supports macOS, Ubuntu and Windows (via WSL2 Ubuntu).If you can’t use the autoinstall script, follow the manual installation steps for your operating system below.
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).
Pull the images and run docker compose:
Copy
Ask AI
COMPOSE_PARALLEL_LIMIT=4 docker compose pulldocker compose up -d
If you face a rate limit while downloading, run the command again.
You can now access the application by navigating to http://localhost.
This procedure has been tested on Ubuntu Server 24.04.
During the Ubuntu Server installation, select Docker to be added to the installation. If you need to install Docker later, follow the instructions here.
Log in to your server and run the following commands to create a folder and download the OpenOps release files:
Copy
Ask AI
# create and change directorymkdir -p openops && cd openops# download the release filecurl -OL https://github.com/openops-cloud/openops/releases/download/0.6.9/openops-dc-0.6.9.zip# refresh package listssudo apt update# install unzipsudo apt install unzip# decompress release fileunzip openops-dc-0.6.9.zip# copy the defaults to env without overwriting existing filescp --update=none .env.defaults .env
Identify your own IP address:
Copy
Ask AI
# find IP addressip -o -4 addr show | awk '{print $2, $4}'
The output should look something like this:
Copy
Ask AI
lo 127.0.0.1/8 # loopback network interface - not hereenp1s0 192.168.1.50/24 # this looks more like it. We want this inet IP address without the subnet mask: 192.168.1.50docker0 172.17.0.1/16 # docker network interface - not here
In this case, the IP address is 192.168.1.50.
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).
In the .env file, find the OPS_PUBLIC_URL variable and replace its value, http://localhost, with the IP address that you’ve previously identified. In our example, the IP address would be http://192.168.1.50.
Pull the images and run docker compose:
Copy
Ask AI
# download the docker volumes and imagesCOMPOSE_PARALLEL_LIMIT=4 sudo docker compose pull# launch the applicationsudo docker compose up -d
If you face a rate limit while downloading, run the command again.
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).
Run docker compose:
Copy
Ask AI
$env:COMPOSE_PARALLEL_LIMIT = "4"docker compose pulldocker compose up -d
If you face a rate limit while downloading, run the command again.
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.
Using Azure CLI in workflows: running with local credentials
It is possible to share your local session with the platform for local applications.
To do this, you need to set two environment variables in the .env file under the installation folder:
OPS_ENABLE_HOST_SESSION=true: enables sharing of the host session with the platform container.
HOST_AZURE_CONFIG_DIR="~/.azure": defines the path to the host machine’s Azure configuration folder that will be shared with the platform container.
