opensimulator-docker/README.md

OpenSimulator

From the OpenSimulator site:

OpenSimulator is an open source multi-platform, multi-user 3D application server. It can be used to create a virtual environment (or world) which can be accessed through a variety of clients, on multiple protocols.

This unofficial Docker configuration aims to assist in setting the server up for testing and general purpose use.

This is still experimental - thar be bugs!

Usage

docker run -d --name opensim -p 9000:9000 -p 9000:9000/udp soupbowl/opensimulator:edge

You can change settings with the following optional environmental overrides:

• -e GRID_NAME=... to define the name of your grid.
• -e GRID_WELCOME=... to show a custom message on the login screen.
• -e REGION_NAME=... to define the Region name.
• -e ESTATE_NAME=... to define the Estate name.
• -e ESTATE_OWNER_NAME=... to set the estate owner name (and creates a login) - format of 'Firstname Lastname'.
• -e ESTATE_OWNER_PASSWORD=... to define a login password.
• -e ESTATE_OWNER_UUID=... for a custom UUID, if desired.
• -e ESTATE_OWNER_EMAIL=... to define the estate email address.
• -e DATABASE_ENGINE=... to change the database engine (sqlite and mysql support so far) - defaults to sqlite.
• -e MYSQL_SERVER=..., -e MYSQL_DATABASE=..., -e MYSQL_USER=..., -e MYSQL_PASSWORD=... if DATABASE_ENGINE is mysql.

Once the server is running, you should be able to connect to it on localhost:9000. In Firestorm Viewer, you can go to Preferences, then Opensim, then under add new grid put localhost:9000 and you can then login.

If you don't define otherwise in the environments or a custom configuration, the login username is Foo bar and the password is password.

Examples

See this repository for some example usages of this image.

Source Code

The source code of the Docker image is found on the GitHub repository. You can find the OpenSimulator server software source code on their website.