admin/opensimulator-docker
1
0
Fork 0
mirror of https://github.com/soup-bowl/opensimulator-docker.git synced 2026-07-30 11:33:45 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updated readme.

Browse Source
This commit is contained in:
soup-bowl
2023-01-29 21:34:18 +00:00
parent 438898ca2d
commit 241cfd2922
1 changed files with 26 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+26 -9
View File
@@ -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/