> ## Documentation Index
> Fetch the complete documentation index at: https://openops-f559c8bf.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Local Deployment

> Deploy OpenOps on your local machine

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.

## On macOS

### Install Docker Desktop

Follow [these instructions](https://docs.docker.com/desktop/setup/install/mac-install/) to install Docker Desktop.

### Run docker compose

1. Open a new Terminal window and run the following command to create a folder and download the OpenOps release files:
   ```shell theme={null}
   mkdir -p openops && cd openops && \
   curl -O https://openops.s3.amazonaws.com/releases/0.2.0/openops-docker-compose-0.2.0.zip && \
   unzip openops-docker-compose-0.2.0.zip && cp -n .env.defaults .env
   ```
2. Pull the images and run docker compose. If you face a rate limit while downloading, run the command again.
   ```shell theme={null}
   COMPOSE_PARALLEL_LIMIT=4 docker compose pull
   docker compose up -d
   ```

You can now access the application by navigating to [http://localhost](http://localhost). The login credentials are configured in the `.env` file, the default username is "[admin@openops.com](mailto:admin@openops.com)" and the default password is "please-change-this-password-1".

## Updating your version

First, stop the running containers:

```shell theme={null}
sudo docker compose down
```

To update your OpenOps docker compose installation, unzip the new release into the same location where you initially installed it:

```shell theme={null}
curl -O https://openops.s3.amazonaws.com/releases/0.2.0/openops-docker-compose-0.2.0.zip && \
unzip -o openops-docker-compose-0.2.0.zip
```

You can then restart the application and fetch the new images:

```shell theme={null}
COMPOSE_PARALLEL_LIMIT=4 docker compose pull -q && docker compose up -d
```

## 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, please follow the steps:

1. Download and create a free account in [ngrok](https://ngrok.com/)
2. Start ngrok

```shell theme={null}
ngrok http http://localhost
```

3. Copy the Forwarding address

   ![Copy the Forwarding address](https://mintcdn.com/openops-f559c8bf/gQJpq14WxmjJU9s5/images/ngrok-public-address.png?fit=max\&auto=format\&n=gQJpq14WxmjJU9s5\&q=85\&s=ab538d34c2e31dc01777633ebc97e86d)
4. Go to the OpenOps installation directory
5. Inside the directory, make a copy of the `.env.defaults` file and save it as `.env`
6. Open the file and set OPS\_PUBLIC\_URL to the Forwarding address you copied in step 3

```shell theme={null}
OPS_PUBLIC_URL=https://2f91-62-77-75-198.ngrok-free.app
```

7. Restart the containers

```shell theme={null}
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 contact [support@openops.com](mailto:support@openops.com) if you have any questions or need help with the installation.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.