User Tools

Site Tools


en:self_hosted_region

Self hosted region

Run your own OpenSim region connected to the Caprica grid. Works on a VPS or a home server with a static IP — a domain name is not required.

Or open a support ticket: https://caprica.xyz/support/


Requirements

Full checklist: REQUIREMENTS.md in the region repository.

Software (Linux):

  • mono-complete — runs OpenSim
  • screen or tmux — keeps the region alive
  • git — to clone the repository
  • python3 — for the web installer
  • mysql-server — optional, only if you want offline IM

Hardware: a 256×256 region needs ~1 vCPU, ~1 GB RAM, ~1 GB disk.

Network:

  • Inbound TCP + UDP on your region port (both required — UDP is the simulator protocol; TCP-only rules make teleports hang)
  • Outbound to g.caprica.xyz:9000 (HTTPS only — Caprica's public services are TLS-only since Nov 2026) and g.caprica.xyz:8003 (HTTP)

Clone the repository and run the web installer:

git clone https://github.com/capricagrid/capricaregion.git /opt/capricaregion
cd /opt/capricaregion
sudo python3 websetup.py --port 8080

It prints a one-time URL with an access key — open it in your browser. The form covers every setting (region name, UUID auto-generated, location, size, port, external IP/hostname, service protocol, SQLite/MySQL storage, firewall). After install the region starts automatically; the page shows the log and start/stop controls, and a FINISH button closes the installer when you are done.

Prefer the console? The interactive wizard does the same:

cd /opt/capricaregion && ./setup.sh

Database

  • SQLite (default): zero setup — *.db files are created inside bin/. Note: offline IM is disabled automatically (the bundled SQLite provider has no OfflineIM backend).
  • MySQL (optional): required for offline messages. Install mysql-server, create a database and user — OpenSim creates the tables on first start. Both installers configure this for you.

First start

On the first launch OpenSim asks for an Estate name and your avatar's first and last name (registered on Caprica) in the screen console:

screen -r <region-name>    # attach once, answer the prompts
# detach: Ctrl+A then D

Wait for the message Login enabled in the console/log.


Manual configuration

The installers write these files for you; edit them by hand only if needed.

1. Region identity — bin/Regions/Regions.ini: region name, UUID (any UUIDv4 — the installers generate one), Location X,Y (pick free coordinates on the Caprica map first), SizeX/SizeY (256/512/1024), MaxPrims, InternalPort = your region port, ExternalHostName = your IP or hostname.

2. Listener port — bin/OpenSim.ini: http_listener_port must match InternalPort.

3. Service protocol — bin/OpenSim.ini constants (already set by the installers): BaseScheme = “https” for Caprica public services (:9000), PrivScheme = “http” for private services (:8003). Do not change these unless Caprica support tells you to.

4. Storage — bin/config-include/GridCommon.ini [DatabaseService] (SQLite include is active by default; uncomment the MySQL StorageProvider/ConnectionString lines for MySQL).


Firewall

Open both protocols for your region port:

sudo ufw allow 9000,8003,8002
sudo ufw allow <region_port>/tcp
sudo ufw allow <region_port>/udp

Going live

  • Make sure /etc/hosts maps your external IP to localhost (needed for IP-only setups): 127.0.0.1 localhost and your external IP followed by localhost
  • Start the region: cd bin && screen -S myregion then mono OpenSim.exe (the installers do this automatically).
  • Add Caprica to your viewer's grid list: grid list setup guide
  • Log in, find your region on the map by name, teleport — in both directions.

Region management: detach screen with Ctrl+A D, reattach with screen -d -r plus your region name, logs in bin/OpenSim.log and the screen console.


Troubleshooting

  • Teleport hangs ~30 s then fails — the region port is open for TCP only. Open UDP too (see Firewall). In the log: “Did not find presence before timeout”, no “Adding new child scene presence”.
  • Crash on startup: “Could not find a storage interface in OpenSim.Data.SQLite.dll” — SQLite has no OfflineIM backend; either disable OfflineMessageModule in OpenSim.ini [Messaging] or configure MySQL.
  • Region missing from the map — check ExternalHostName reachability and that the port TCP is open.
en/self_hosted_region.txt · Last modified: 2026/11/07 21:00 (external edit)

Page Tools