Skip to content

README.md

Latest commit

 

History

History
42 lines (34 loc) · 2.04 KB

README.md

File metadata and controls

42 lines (34 loc) · 2.04 KB
Raw

Local Docker Compose

From the repository root, run docker compose up -d --build, then open http://localhost:8080. Docker with Linux containers is required. Compose supplies defaults; no .env file is required. The application container uses Docker's init process to reap orphaned agent subprocesses.

To customize, copy .env.example to .env in the repository root. The .env file is ignored by Git. Shell environment variables take precedence. OMB_HTTP_PORT changes the host port and the default public URL. Internal service ports remain fixed inside the shared network namespace. ENGINES selects space-separated npm packages; an empty value skips installation.

For Tailscale Serve, set OMB_PUBLIC_URL to your HTTPS URL and OMB_HTTPS_HOST to its hostname without scheme or path. Configure Tailscale Serve on the host to forward to the chosen localhost HTTP port. Keep the default OMB_BIND_ADDRESS=127.0.0.1. Caddy refuses to start when OMB_HTTPS_HOST is set with any other bind address, so direct remote HTTP clients cannot claim HTTPS semantics by supplying that hostname. The hostname mapping preserves HTTPS semantics for that host while localhost access continues to use HTTP. Private tailnet webhook URLs are only reachable by callers on that tailnet. Without OMB_HTTPS_HOST, the bind address can be changed for HTTP access. Only use HTTPS hostname mapping with a trusted local TLS-terminating proxy.

Sign in and pair a browser:

docker compose exec omb codex login --device-auth
docker compose exec omb node dist-server/openmausbot.js pair

On Windows, ./maus.ps1 forwards arguments to Compose using the repository directory. It respects Docker's selected context and DOCKER_CONTEXT.

Data and engine credentials persist in the named data volume. For an existing volume, set OMB_DATA_VOLUME to its name and OMB_DATA_EXTERNAL=true. Fresh installs create their volume automatically.

Update with docker compose build --pull followed by docker compose up -d. Stop with docker compose stop. docker compose down -v deletes managed volumes.