Skip to content

olympus-btc/ambrosia-instance-manager

Repository files navigation

Ambrosia Instance Manager

Standalone local web app to manage isolated Docker-based Ambrosia instances.

Requirements

  • Node.js 22+
  • Docker with either docker compose or docker-compose
  • A local Ambrosia source repo available on disk

Dependencies

Runtime

  • Node.js to run the local web server
  • Docker Engine to build and run Ambrosia instance containers
  • Docker Compose support through docker compose or docker-compose
  • A local Ambrosia checkout with server/ and client/ directories

Bundled

  • qr.js vendored under vendor/qr.js for local QR generation
  • Ambrosia icon asset under public/ambrosia-icon.png for the web UI

By default, this manager expects the Ambrosia source repo at:

~/code/ambrosia

If your Ambrosia repo is elsewhere, set AMBROSIA_SOURCE_DIR before starting the manager.

Start

cd ~/code/ambrosia-instance-manager
npm start

The UI runs on http://127.0.0.1:3010 by default.

Config

AMBROSIA_SOURCE_DIR

Path to the Ambrosia repo used to build instance containers.

Example:

AMBROSIA_SOURCE_DIR=~/code/ambrosia npm start

INSTANCE_DATA_DIR

Optional path for instance metadata and per-instance env files.

Example:

INSTANCE_DATA_DIR=~/.local/share/ambrosia-instance-manager npm start

What it does

  • Creates isolated Ambrosia instances with a unified gateway port (Reverse Proxy)
  • Automatically routes /api to the backend and root to the frontend
  • Lists local instances and their runtime status
  • Starts, stops, rebuilds, and deletes instances
  • Exposes each instance with a single public URL (Ngrok/Cloudflare compatible)
  • Tracks background jobs with progress so actions stay blocked until they finish

By default, instance metadata is stored in:

~/code/ambrosia-instance-manager/.ambrosia-instances

About

Ambrosia Instance Manager is a local web app that creates and manages isolated Docker-based Ambrosia instances. Each instance gets its own ports, volumes, Phoenixd service, and shareable LAN URL with QR access, making it easy to demo a fresh self-hosted Ambrosia experience from one machine.

Resources

License

Stars

0 stars

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors