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.

Installing OpenOps

Run the following command in your terminal to install, update, configure and run OpenOps:
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.

Updating OpenOps to a newer version

See Updating OpenOps.

Cloud templates

On localhost, cloud templates may not be able to load when using the Safari browser.

Configuring Slack approvals

If you would like to run a workflow that uses Slack approvals in a local installation, you should set the following variable in your .env file:
OPS_SLACK_ENABLE_INTERACTIONS=false
This will open a new tab in your default browser when you approve or reject an action. You can safely close the tab after the action is completed.
After updating your .env file, restart the containers:
sudo docker compose down && docker compose up -d

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.

Support

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