From 8208debc1c1cc5af51704de01a0624018bdbb8a8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adri=C3=A1n=20Parilli?= Date: Wed, 18 Nov 2020 21:43:20 -0400 Subject: [PATCH] Format and spacing --- Database.md | 11 +++++++++++ README.md | 17 +++++++++++------ 2 files changed, 22 insertions(+), 6 deletions(-) create mode 100644 Database.md diff --git a/Database.md b/Database.md new file mode 100644 index 0000000..a4f5575 --- /dev/null +++ b/Database.md @@ -0,0 +1,11 @@ +### Database Server + +Connecting the simulator to a databse does not differ much from standard setup specified at [OpenSim Database Settings](http://opensimulator.org/wiki/Database_Settings), excepting by the fact Opensim Engine and DB Server will always reside on different hosts, and will communicate via network. You need to setup both OpenSim config files (a.k.a. DB client) and your DB Server considering this fact. + +In many scenarios, you will want (or at least results practical) to run this DB Server inside a container as well. If this is the case, additional Docker setup is needed to ensure a virtual network where both containers can communicate is essential. + +Finally, as an up and running DB Server is a pre-requisite for OpenSim to start, it is ideal to create a Stack with Docker Compose or Kubernetes, where the DB takes precedence starting. + +Opensim Engine has been tested and runs nice with the [*Official MySQL Docker Images*](https://hub.docker.com/_/mysql) BUT, + +*As of OpenSim 0.9.1.1 and based distros, 'latest' MySQL images won't work because have authentication issues, so it is recommended to use 5.7.xx images instead, until OpenSim code is updated for MySQL version 8.* diff --git a/README.md b/README.md index 98b69ce..431f4be 100644 --- a/README.md +++ b/README.md @@ -1,25 +1,30 @@ # OpenSim Engine -- Readme ## Overwiew: -OpenSim Engine is intended to run OpenSim based simulators -Although its main goal is to be part of a more elaborated solution to deploy simulators and/or grids, it can be used *as is* to test and even run (very simple) configurations inside containers. +OpenSim Engine is intended to run OpenSim based simulators. Its main goal is to be part of a more elaborated solution to deploy simulators and/or grids, but can be used *as is* to test and even run (very simple) configurations inside containers. ## Features: -- Built upon the latest version of Mono (6.xx) +- Built upon the latest version of Mono - Contains minimal tools to download and manipulate ZIP compressed binaries inside the container - It runs OpenSim.exe onto a detachable console you can access the main screen, see status and use CLI. - Allows both standalone sims/grids (e.g. OpenSim, DivaDistro), and also connect your sims to existing grids (e.g. OSGrid) -NOTE: The image does not provide the simulator files, you have to provide them yourself. +NOTE: The image does not provide simulator files, you have to download/uncompress it yourself. ## Requirements: - Docker Engine. See [Docker Documentation](https://docs.docker.com/get-docker/) for further instructions -- Main simulator folder tree uncompressed, and accessible by Docker with write permissions +- Uncompressed main simulator folder tree, accessible by Docker with write permissions ### Basic Usage Useful for tests, and also for running very simple configurations (e.g. standalone and/or default SQLite setup): -`docker run -it --restart= --name -v :/opensim -p 9XXX[-9YYY]:9XXX[-9YYY]/tcp -p 9XXX[-9YYY]:9XXX[-9YYY]/udp adrianparilli/opensim-engine[: