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 ++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 129 insertions(+), 1 deletion(-) (limited to 'doc/configuration.html') 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.

+ -- cgit v1.1