From 241cfd29223f6e5be5089061acf973e29912717a Mon Sep 17 00:00:00 2001 From: soup-bowl Date: Sun, 29 Jan 2023 21:34:18 +0000 Subject: [PATCH] Updated readme. --- README.md | 35 ++++++++++++++++++++++++++--------- 1 file changed, 26 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index b4de3a5..36889d7 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,34 @@ -# OpenSimulator in Docker +# OpenSimulator -Work in progress to contain the OpenSimulator server software in a Docker container. +From the [OpenSimulator][os] site: -**Not ready for general use.** + 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. -## Usage +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 + ```bash -docker run -d \ - --name opensim \ - -p 9000:9000 \ - -p 9000:9000/udp \ - ghcr.io/soup-bowl/opensimulator-docker:edge +docker run -d --name opensim -p 9000:9000 -p 9000:9000/udp ghcr.io/soup-bowl/opensimulator-docker: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**. + +[os]: https://opensimulator.org/