From c342c299af286083a60e447f3f4cbdc84f5cfbfa Mon Sep 17 00:00:00 2001 From: onefang Date: Thu, 29 Aug 2019 13:14:13 +1000 Subject: Docs++ --- doc/configuration.html | 130 ++++++++++++++++++++++++++++++++++++++++++++++++- doc/index.html | 13 ++--- doc/scripts.html | 113 ++++++++++++++++++++++++++++++++++++++++++ doc/web_pages.html | 4 +- 4 files changed, 251 insertions(+), 9 deletions(-) (limited to 'doc') diff --git a/doc/configuration.html b/doc/configuration.html index 9844414..0f42529 100644 --- a/doc/configuration.html +++ b/doc/configuration.html @@ -3,6 +3,134 @@ -

+ +

opensim-SC uses the same configurations as OpenSim, with some +small changes, so please refer to their documentation. +Only the differences will be detailed here.

+ +

OpenSim ships with some pre-compiled executables and libraries, plus +other files in it's own bin/ directory, and wants to write the rest of +it's files there as well. Some existing configuration options let you +move some of those writable areas out of the tree, but not all. +opensim-SC tries to move all writable stuff and configuration out of +tree, to make updates easier. InstallItAll.sh builds this structure in +/opt/opensim_SC, and copies itself to /opt/opensim_SC/opensim-SC.

+ +

The two main configuration files are +/opt/opensim_SC/opensim-SC/bin/Robust.ini and +/opt/opensim_SC/opensim-SC/bin/OpenSimDefaults.ini. You should not modify +those. They include files from +/opt/opensim_SC/opensim-SC/bin/config-include, which you should also not +modify. Instead there are various directories and config files in +/opt/opensim_SC/config where you can over ride the configuration options +you want to change.

+ +

/opt/opensim_SC/config/config.ini

+ +

This will start as a copy of one of the +/opt/opensim_SC/opensim-SC/bin/config-include/config_*.ini files. Copy +config_localhost.ini if you want to run your own grid, or one of the +others if you want to connect to IG or MG. It is used by both ROBUST and +by sims. It must be NOT world readable, as it contains your database +login details.

+ +

By default this file includes two sections. [Paths] and [Const], but +you can add more sections in this file if you need to override those +sections from the configuration files in the bin/ directory.

+ +

[Paths] is the paths to the various movable directories, relative to +the /opt/opensim_SC/opensim-SC/bin/ directory. + +

AssetsPath - where your assets are stored.
BackupPath - where IAR and OAR backup files are created.
CachePath - the directory that holds various caches.
ConfigPath - this /opt/opensim_SC/config/ directory that we are describing.
DbPath - a directory with some small statistics databases.
LogPath - where the logs and console history are kept.
WebPath - where the various web pages are served from.

+ +

[Const] is various constants used in the rest of the configuration +files, so you can define these here once.

+ +

MOTD - the message that is shown to people when they log on.
GridName - the name of the grid.
ShortGridName - the short name of the grid, usually the initials of GridName.
BaseHostName - a HTTP URL that is used as the base of all other URLs.
HostName - the domain name of your grid.
BaseURL - built from BaseHostName usually.
GridURL - built from BaseHostName usually.
SSLURL - built from HostName usually.
PublicPort - public port used by ROBUST services.
PrivatePort - private port used by ROBUST services.
PublicSSLPort - public port used by ROBUST services in SSL mode.
AssetServerPort - public port used by the ROBUST asset service.
DataProvider - used to select between the various SQL backends, though opensim-SC only supports MariaDB / MySQL.
ConnectionString - the details of how to connect to your SQL backend. This contains credentials that need to be protected from others reading them.

+ +

NOTE - though SSL is mentioned above, SSL is not well supported in +OpenSims own web server. They wrote their own, the SSL parts are not +well tested, being rarely used. Probably best to not use SSL now. In +the next major version of opensim-SC I intend to use an external web +server, and shift things over to it. Lighttpd is the likely choice.

+ +

/opt/opensim_SC/config/ROBUST/RobustExtra.ini

+ +

This is where you would override ROBUST specific configuration options. By default it will be empty.

+ +

/opt/opensim_SC/config/simXX/ThisSim.ini

+ +

For each sim you need to specify certain options, and you can override +others. /opt/opensim_SC/config/sim_skeleton/ThisSim.ini is a template +used by the create_sim script to create this file. Newer versions of +create_sim might give this file the name of the sim, My_New_Sim.ini.

+ +

The "SIM_*" bits get replaced with actual information for each sim. +It has it's own [Const] section, which only contains mysim, the number of +this sim. The [Startup] section defines various file locations. The +[Network] section defines the public port for this sim.

+ +

OpenSim had the [Region] section in different files, in two +different formats, instead opensim-SC includes that info here so it's all +in one place per sim. RegionName is the name of your sim, the rest are +described in OpenSims Configuring +Regions page.

+ +

The [Performance] section is new to opensim-SC. It includes one of the +/opt/opensim_SC/opensim-SC/bin/config-include/Sim*.ini files that give +you a choice of performance trade offs.

+ +

New options.

+ +

There have been some additional options added to support new features. Some have been mentioned above.

+ +

[AuthorizationService]

DefaultRegionAccess - Set the default access restriction for any sim not otherwise mentioned in this section.

[Groups]

AddDefaultGroup - automatically add any members of your grid to this | separated list of groups.
AddHGDefaultGroup_othergrid.com - same as above, but for hypergrid visitors from a specific grid.

[GodNames]

FirstNames - similar to the other GodNames options, but this is a list of first names that designate gods for viewers. Note that viewers may not support this.

+ +

Removed options.

+ +

Some options have been removed. Mostly limitations, or useless cruft. +You wont miss them. In one instance a viewer bug that had been fixed a +decade ago, was still being forbidden in OpenSim.

+ diff --git a/doc/index.html b/doc/index.html index b2043e4..ad4352d 100644 --- a/doc/index.html +++ b/doc/index.html @@ -20,10 +20,11 @@ Second Life viewers.

What is SledjHamr?

opensim-SC is part of the SledjHamr project. SledjHamr is a rewrite from -scratch of Second Life (SL) / OpenSim (OS) style 3D online virtual world -client / server. The plan is to use OS server and SL clients as crutches, -when a bit of SledjHamr is ready, it replaces the matching bit in OS/SL.

opensim-SC is part of the SledjHamr project. SledjHamr will be a +rewrite from scratch of Second Life (SL) / OpenSim (OS) style 3D online +virtual world client / server. The plan is to use OS server and SL +clients as crutches, when a bit of SledjHamr is ready, it replaces the +matching bit in OS/SL.

SledjHamr - tearing down the garden walls.

@@ -89,9 +90,9 @@ INSTALL.md for installation details.

The scripts are documented here.

The new configuration setup and options are documented here.

The example web pages are documented here.

diff --git a/doc/scripts.html b/doc/scripts.html index 55b8d26..8551a79 100644 --- a/doc/scripts.html +++ b/doc/scripts.html @@ -3,6 +3,119 @@ +

There are various scripts included, mostly Bash shell scripts.

+ +

opensim-SC/BuildIt.sh

This script will compile, or recompile the entire system.

+ +

opensim-SC/InstallItAll.sh

+ +

Installs everything on a Debian like operating system. You will need +to know your root/sudo password and your MariaDB root password, though if +MariaDB isn't installed, it will be installed. Note that some recent +versions of MariaDB want to be passwordless for root.

+ +

opensim-SC/TestIt.sh

Runs unit tests on opensim-SC.

opensim-SC/nant-color

Obsolete since Debian removed nant, but used to be part of the build system.

opensim-SC/runprebuild.bat and opensim-SC/runprebuild.sh

Parts of the build system.

opensim-SC/example/start.sh

An example script that runs a specific sim.

opensim-SC/scripts/backup-grid.sh

Backup the entire grid into gitAR archive files, which are like IAR and OAR files, only with git info in them, and compressed better.

opensim-SC/scripts/backup-inventories.sh

Backup inventories of anyone that has logged on in since the last time this was run.

opensim-SC/scripts/backup-inventory

Backup a single accounts inventory. It's a symlink to start-sim, which figures out what to do based on the name it is called as.

opensim-SC/scripts/backup-sims.sh

Backup all currently running sims.

opensim-SC/scripts/common.sh

Common data and functions for the other scripts.

opensim-SC/scripts/fix_some_assets.pl

An old script to fix some problems caused by a bug in OpenSim. Not sure it's needed anymore, or even if it'll work. Probably best to not use it.

opensim-SC/scripts/gitAR.sh

Script for dealing with gitARs, though not meant to be used by users.

opensim-SC/scripts/show-console

Show the tmux consoles.

+ +

opensim-SC/scripts/start-sim

+ +

Start / stop sims, backup inventories / sims. This script does +different things depending on where it is called from, and the name it is +called as. It has afew options you can pass to it on the command line.

+ +

-a - Used internally as part of the "start up everything" mentioned below.
-d X - Define a delay to wait between sims when starting up everything, the default is 60 seconds.
-q - Don't show the tmux console os start up.
-w - Wait until the "INITIALIZATION COMPLETE FOR " line shows in the console before continuing.

+ +

Called as backup-inventory

Backs up the inventory of the user specified in the arguments to an .iar file and updates the _gitIAR.tar.xz file.

+ +

   ./backup-inventory Avatar Name

+ +

Called as backup-sim from config/simXX

Backs up the sim to an .oar and updates the _gitOAR.tar.xz file.

+ +

Called as start-sim from config/ROBUST

Starts up ROBUST if it is called from the config directory holding the ROBUST configuration.

+ +

Called as start-sim from config/simXX

Starts up the sim if it is called from the config directory holding the sim configuration.

+ +

Called as start-sim from opensim-SC/scripts

Will start up everything.

+ +

Called as start-sim from opensim-SC/bin

Used internally by the "start up everything" process to start up the sims. It assumes that ROBUST was recently started.

+ +

Called as stop-sim from config/ROBUST

Stops ROBUST if it is called from the config director holding the ROBUST configuration.

+ +

Called as stop-sim from config/simXX

Stops the sim if it is called from the config director holding the sim +configuration. It gives users on the sim a couple of warnings, waits a +while, then shuts down the sim.

+ +

opensim-SC/scripts/install/create_sim.sh

Create a sim. Ther are several optional arguments. If an argument is missing or blank, a default is used.

+ +

"sim name" - The name of the sime you want, the default is "No name sim XXX" where XXX is a random number.
1234,1234 - The map location of the sim, the default is some random location.
256 - The size of the sim, the default is 256 x 256 meters.

+ +

   ./create_sim "My Dobule Sized Sim", 1234,1234 512

+ +

opensim-SC/scripts/install/go_live.sh

+ +

Installs the monit config files. Note that a recent version of Monit +seems to have issue with this, that I haven't tracked down yet. Monit +isn't needed most of the time, and I want to replace it with something +internal in the next major release.

+ +

opensim-SC/scripts/install/group_migrate.sql

An obsolete SQL script for migrating to OS groups.

opensim-SC/scripts/install/opensim-monit.conf

The template monit config file.

+ +

opensim-SC/scripts/install/opensim.tmux.conf

+ +

The tmux config file. Note that tmux has a tendency to change how +their config files work from one version to the next. It would be wise +to test this before trying to use it.

+ +

opensim-SC/scripts/install/secure.sh

+ +

Script to properly set ownership and permissions for files and +directories in opensim-SC. Once you have a lot of assets, this wil take +along time. It is called from InstallItAll.sh

diff --git a/doc/web_pages.html b/doc/web_pages.html index 4ea5aa3..6a76b00 100644 --- a/doc/web_pages.html +++ b/doc/web_pages.html @@ -15,9 +15,9 @@ and PublicPort to be.

grid. There are also a few PNG images that you can replace.

about.html

The web page grid managers will show as "web site".

The web page grid managers will show as "web site". I don't think any viewers actually show or link to this.

help.html

The web page grid managers will show as "support URL".

The web page grid managers will show as "support URL". I don't think any viewers actually show or link to this.

loginpage.html

This is the web page shown in viewers when they pick your grid to log onto.

password_help.html

-- cgit v1.1