Skip to main content
Use Docker when you want OpenSRE in a container — same image on your laptop or a server. For day-to-day CLI use on your machine, the normal install is simpler.

​
Prerequisites

Install Docker first:

Docker Desktop (Mac)

Install Docker Desktop on macOS.

Docker Engine (Ubuntu)

Install Docker Engine on Ubuntu.
Aim for a machine with enough CPU and RAM for your LLM calls and any tools you connect (roughly 4 cores / 8GB is a comfortable start).

​
1. Build the image

From a clone of the OpenSRE repo:
The image contains the runtime tools. It does not pin an OpenSRE build: on start it installs the current main-channel build. Inside a running container, opensre update -y installs a newer main build and restarts the process onto it. Rebuild the image when Git, the GitHub CLI, Node, or Codex should change, not for an application change. The image can run in two modes via MODE:
  • web (default) — HTTP API for health checks
  • gateway — messaging gateway (Slack / Telegram / Discord / Buzz) plus related services

​
2. Run web mode

Put your LLM keys (and any integration secrets) in a .env file — see .env.example in the repo — then:
Check it’s up:
Minimum env for an LLM (example):

​
3. Run gateway mode (optional)

If you want Slack Socket Mode, Telegram, Discord, and/or Buzz on the gateway:
You’ll need the usual LLM vars plus the matching messaging tokens. Details: Deployment and Messaging.

​
Prefer the CLI instead?

On the host (not in Docker):
See Install and Quickstart.

​
Next