OpenSimulator · EN

Install an OpenSimulator grid with ROBUST

Separate central ROBUST services, databases and region simulators.

Learning path for OpenSimulator 0.9.3.1 / .NET 8. Adapt domains, secrets, versions and ports to your installation. Verify source files before production.

How a grid works

The viewer connects through grid login services; ROBUST provides central services while OpenSim processes host regions. They may share one host or run separately, but public and private URLs must be consistent.

Plan the infrastructure

Prepare grid service DNS, private ROBUST-to-simulator networking, database, backups and region ports. Record actual egress IPs and firewall policies. Do not expose internal services for convenience.

Deploy matching binaries

Install and build a compatible .NET 8 OpenSimulator base for ROBUST and simulators. On upgrades, keep modules compatible and avoid unvalidated DLL mixing.

Prepare MySQL

For a persistent grid, create a dedicated SQL database and restricted account with private-only access. The ROBUST template uses [DatabaseService] with StorageProvider and ConnectionString. Never expose MySQL to the internet.

Adapt this example: verify paths, hostnames, permissions and settings.

CREATE DATABASE opensim CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;
CREATE USER 'opensim'@'localhost' IDENTIFIED BY 'REPLACE_WITH_STRONG_SECRET';
GRANT ALL PRIVILEGES ON opensim.* TO 'opensim'@'localhost';
-- Pour un serveur SQL distant, adaptez l'hôte et les restrictions réseau.

Create Robust.ini

Copy Robust.ini.example to Robust.ini, configure [Const], [DatabaseService], connectors and services. The template uses PublicPort=8002 and PrivatePort=8003: sample defaults, not universal requirements. Restrict private service access.

Adapt this example: verify paths, hostnames, permissions and settings.

cd bin
test ! -e Robust.ini && cp Robust.ini.example Robust.ini

Understand ROBUST constants

BaseHostname is the server address, BaseURL its HTTP/HTTPS base and PublicPort/PrivatePort are template ports. Follow constant references throughout the file, not just the login port.

Adapt this example: verify paths, hostnames, permissions and settings.

[Const]
BaseHostname = "grid.example.org"
BaseURL = "http://${Const|BaseHostname}"
PublicPort = "8002"
PrivatePort = "8003"

Start ROBUST first

Start ROBUST before regions, from its bin directory, explicitly selecting Robust.ini. Wait for all services and inspect logs. A login page alone does not prove assets or inventory work.

Adapt this example: verify paths, hostnames, permissions and settings.

cd bin
dotnet Robust.dll -inifile=Robust.ini

Configure OpenSim.ini for Grid

On each simulator copy OpenSim.ini.example and GridCommon.ini.example to their active names. Under [Architecture] choose Grid.ini or GridHypergrid.ini (only with a properly configured Hypergrid). Do not mix Standalone and Grid includes.

Adapt this example: verify paths, hostnames, permissions and settings.

cd bin
test ! -e OpenSim.ini && cp OpenSim.ini.example OpenSim.ini
test ! -e config-include/GridCommon.ini && cp config-include/GridCommon.ini.example config-include/GridCommon.ini
# Dans OpenSim.ini :
[Architecture]
Include-Architecture = "config-include/Grid.ini"

Connect regions to ROBUST

GridCommon.ini service URIs (assets, inventory, grid, avatar, etc.) must resolve to the actual ROBUST services. The example relies on PrivURL, PrivatePort, BaseURL and PublicPort. Private URLs must be routable from simulator hosts, including across VMs.

Adapt this example: verify paths, hostnames, permissions and settings.

[AssetService]
AssetServerURI = "${Const|PrivURL}:${Const|PrivatePort}"
[InventoryService]
InventoryServerURI = "${Const|PrivURL}:${Const|PrivatePort}"
[GridService]
GridServerURI = "${Const|PrivURL}:${Const|PrivatePort}"

Create the first region

Each region needs a unique RegionUUID, suitable map coordinates, a nonconflicting InternalPort and an ExternalHostName reachable by viewers. Check TCP/UDP, firewall and NAT. Do not assign the same listening port to competing processes on one address.

Start a simulator and verify

After ROBUST services are ready, start OpenSim from bin, create a region and verify registration. Correct startup order simplifies troubleshooting, but a manual restart is not a fix for persistent connectivity errors.

Adapt this example: verify paths, hostnames, permissions and settings.

cd bin
./opensim.sh
# Dans la console du simulateur :
show region
stats show

Hypergrid is a separate setup

GridHypergrid.ini and Robust.HG.ini.example describe additional Gatekeeper, HomeURI and UserAgentService requirements. Verify DNS, routes, published addresses, permissions and services before enabling Hypergrid. The basic Grid guide does not automatically configure it.

Security and backup

Protect SQL credentials and private ROBUST ports; back up database, assets and configs before upgrades. Test restore on a non-production grid before major changes.

Next steps and references

Configure Hypergrid: ROBUST HG, Gatekeeper and HomeURI

Networking, TCP/UDP ports, DNS and firewall