Get It

Deploy your AI-enabled OpenSimulator grid in minutes.

1 Prerequisites

Docker Compose

You need Docker Engine and Docker Compose v2 (docker compose) installed.

Install Docker Compose

OpenSimulator Viewer

A viewer is how you log in to your grid. We recommend Firestorm, but any compatible viewer works.

Firestorm Singularity Cool VL

2 Compose

Clone the repository and switch into it:

git clone https://github.com/opensim-stack/opensim-ai-docker.git
cd opensim-ai-docker

Create your environment file from the example:

cp .env.example .env
You must set OPENSIM_HOSTNAME in .env or the stack will only work on localhost.

Start the release stack (recommended for first-timers):

docker compose -f docker-compose.release.yml up -d

Or use the helper script for a local release build:

./run-release.sh
View docker-compose.release.yml View .env.example

3 Key Environment Variables

VariableDefaultPurpose
OPENSIM_HOSTNAMEopensimPublic hostname for the grid. Required to change.
OPENSIM_REGION_NAMEWelcome IslandName of your first region.
OPENSIM_REGION_PORT9000Simulator TCP/UDP port.
OPENSIM_ESTATE_OWNER_FIRSTAdminEstate owner first name.
OPENSIM_ESTATE_OWNER_LASTUserEstate owner last name.
OPENSIM_ESTATE_OWNER_PASSWORDchangemeEstate owner password. Change before exposing externally.
OPENSIM_LOGIN_FIRSTNAMEBotBot avatar first name.
OPENSIM_LOGIN_LASTNAMEUserBot avatar last name.
OPENSIM_LOGIN_PASSWORDbotpasswordBot avatar password.
MARIADB_PASSWORDopensimpasswordMariaDB application password.
MARIADB_ROOT_PASSWORDrootpasswordMariaDB root password.
See .env.example for the full list of variables, including MCP ports, Opencode settings, and LSL bridge options.