Update documentation.

Write some more.

Correct some spelling errors.

Clean up some out of date stuff.

Make it consistant.

Rearrange things.

1 files changed, 66 insertions, 52 deletions

diff --git a/INSTALL.md b/INSTALL.md
index 6b0d234..40bf35b 100644
--- a/INSTALL.md
+++ b/INSTALL.md
@@ -1,15 +1,10 @@
-NOTE - this is the OpenSim 0.9.0.1 version in the SledjChisl branch,
-which isn't quite ready yet.  Use 0.8.2.1 in the master branch for the
-stable well tested version.
-
-
-Use this to create a sim that links into Infinite Grid or Misfitz Grid
-from Linux.
+Use this to create a sim that links into IG or MG grids from Linux.  Or
+to run your own grid.
 
 It's only been tested on Ubuntu 10.04, 11.04, 12.04, 16.04, as well as
-Debian 8, and Devuan 9, YMMV.  This is also a WIP, use it at your own
-risk.  It's been used to set up a few freshly installed servers though. 
-It should work on recent Debian based Linux distros.
+Debian 8, Devuan 9, and Devuan 9.  YMMV.  This is also a WIP, use it at
+your own risk.  It's been used to set up a few freshly installed servers
+though.  It should work on recent Debian based Linux distros.
 
 You may want to use the latest Mono, you can get it by following the
 instructions at -
@@ -28,11 +23,11 @@ terminal, run the following command -
 This will install the prerequisites (MariaDB, monit, MONO, tmux,
 uuid-runtime); create a database in MariaDB called opensim_SC and a
 database user called opensim_SC with a random password; add a Linux user
-to your system called opensimsc; create the /opt/opensim_SC directory to
-run it all from; copy everything to /opt/opensim_SC/opensim-SC_0.9.0.1;
-setup the directory structure needed to run it all; create some default
-configuration files; build OpenSim-SC; and finally change ownership and
-file permissions for everything.
+and group to your system called opensimsc; create the /opt/opensim_SC
+directory to run it all from; copy everything to
+/opt/opensim_SC/opensim-SC_0.9.0.1; setup the directory structure needed
+to run it all; create some default configuration files; build opensim-SC;
+and finally change ownership and file permissions for everything.
 
 You will likely need to login your user again, so you get the new group
 assigned to it.  Otherwise the tmux stuff in start-sim might fail.
@@ -48,21 +43,26 @@ sudo ./create_sim.sh "My new sim" "1234,5678"
 
 At this point /opt/opensim_SC/config/config.ini will be a symlink
 pointing to config_localhost.ini, which is for a standalone sim.  If you
-want your new random sim to be part of Infinite Grid (IG) or Misfitz Grid
-(MG) then you'll have to change that syml/ink to point to config_IG.ini or
-config_MG.ini respectively.
+want your new random sim to be part of IG or MG grids then you'll have to
+change that syml/ink to point to config_IG.ini or config_MG.ini
+respectively.  There is no point doing that unless you are a member of
+those grids.
 
 /opt/opensim_SC/config/sim01 now contains the actual configuration of
 your randomly created sim.  Edit the .ini file to make that sim a little
-less random.
+less random.  You can even rename the .ini file to match your sim name.
+
+If you are running a grid run -
 
-Finally run -
+cd /opt/opensim_SC/config/ROBUSH
+./start-sim
+
+Then to actually startup your sim -
 
 cd /opt/opensim_SC/config/sim01
 ./start-sim
 
-To actually startup your sim.  And if you want to see the console of your
-sim run -
+And if you want to see the console of your sim run -
 
 cd /opt/opensim_SC/current/scripts
 ./show-console
@@ -75,7 +75,7 @@ The various directories are -
 
 .git            Used by git for it's internal accounting, and the older versions.
 
-.nant           Used by the nant build tool.
+.nant           Used by the obsolete nant build tool.
 
 OpenSim         OpenSim source code.
 
@@ -113,20 +113,13 @@ db		If you are not using MySQL, your data lives here.
 
 logs            Log files get stored here.
 
+web             Web files go here.  You can edit them to change the background image for example.
+
 
 Follow these steps.
 -------------------
 
-Go to -
-
-https://www.infinitegrid.org/drupal/content/How_to_link_your_OpenSim_region_to_Infinite_Grid_LinuxMySQL
-
-and follow the directions to create an admin user account.  You can skip
-that bit if you already have a suitable user with sudo access.
-
-Note that these scripts pretty much follow that above wiki description,
-with some exceptions.  The configuration information per sim has been
-rearranged so that there is only ONE copy of the OpenSim installation.
+First you need to have a user on your computer with sudo access.
 
 Next you need to figure out what password you want to use for OpenSims
 access to the database.  We will call this "DatabasePassword".  Run the
@@ -146,37 +139,45 @@ sims.  You will need -
 A name for your sim, we will use "My new sim".  It should be unique on
 the grid.
 
-Your host name, or it could be your IP, we will use "sims.example.net".
-
-A location for your sim, we will use "1234,5678".  You can use the
-Infinite Grid web based map to poke around and find a good location. 
-Choose an empty spot.
+A location for your sim, we will use "1234,5678".  Choose an empty spot.
 
 Once you have all that information sorted out, run this script from the
 scripts/install directory -
 
 ./create_sim.sh "My new sim" "1234,5678" "sims.example.net"
 
-Or this if you want to override the detected IP address -
+Also, you can create a varregion with something like -
 
-./create_sim.sh "My new sim" "1234,5678" "sims.example.net" "1.2.3.4"
+./create_sim.sh "My new sim" "1234,5678" 512
 
-Also, you can create a varregion with something like -
+Note that the size has to be a multiple of 256, so 512, 768, 1024, etc. 
+8096 is the maximum size, 2048 is about the biggest that is decently
+manageable.
 
-./create_sim.sh "My new sim" "1234,5678" "sims.example.net" "1.2.3.4" 512
 
-Note that the size has to be a multiple of 256, so 512, 768, 1024, etc.
+Running ROBUST.
+---------------
+
+If you are running your own grid, you need to start up ROBUST, which is
+a bunch of common services sims use.  Go to /opt/opensim_SC/config/ROBUST
+and run the following script to start it up -
+
+./start-sim
+
+You will see the tmux console.  You can run the tmux console again by
+running that command once more, or running the show-console script.
+
 
 Running sims.
 -------------
 
-Now you can go to /opt/opensim/config/sim01 and run the following script
+Now you can go to /opt/opensim_SC/config/sim01 and run the following script
 to start it up -
 
 ./start-sim
 
-You will see the screen console.  You can run the screen console again by
-running that command once more, or running the sim-console command.
+You will see the tmux console.  You can run the tmux console again by
+running that command once more, or running the show-console script.
 
 You can stop the sim with -
 
@@ -187,12 +188,23 @@ You can backup the sim with -
 ./backup-sim
 
 
+Running it all at once.
+-----------------------
+
+You don't have to run ROBUST, then each sim, you can run the lot at once.
+Go to /opt/opensim_SC/current/scripts and run -
+
+./start-sim
+
+It'll wait a minute between sims to give things time to settle down, and
+not over work your computer.
+
 
 Finishing up.
 -------------
 
 Once it's all tested, you can use this to finish things off (back in
-the scripts directory) -
+the /opt/opensim_SC/current/scripts directory) -
 
 ./go_live.sh
 
@@ -201,14 +213,16 @@ it all, and you still have to do the basic configuration and enabling of
 monit yourself.  This is in case you already have monit set the way you
 like.
 
+This step is entirely optional, and some versions of monit might not work
+so well.
+
 
 NOTES -
 
 This attempts to use only one copy of the OS install for all sims.  We
 are running one instance of OS for each sim though, as this prevents one
 sim crashing from bringing down the others.  OS however really wants to
-write data to directories within it's own bin directory.  I'm not at all
-certain if that data can be shared.  For the same reason, so far I've
-not been able to get to the point where we can make the OS directory
-read only.  This complicates things during upgrades.
-
+write data to directories within it's own bin directory.  The preferred
+way to update opensim-SC is to download a fresh copy, run BuildIt.sh,
+delete the installed copy, then copy this new one to where the old one
+used to be.  I'll write an update script in the next version.