Configuration of the file “OpenSim.ini”

In OpenSim.ini a lot of settings can be changed, it is the largest configuration file. You can take the example file “OpenSim.ini.example” included in OpenSim 0.9.1 as basis.

Important Note: Larger grids, like OSgrid shown in this example, offer special preconfigured OpenSim downloads. They already have the grid specific settings suitably set. We will still look at the file in detail to learn something…

We begin with the necessary settings and will get over some additional optional settings, later.

If OpenSim 0.9.1 is used, normally the physics engine “BulletSim” is used as default. Otherwise activate this option, if you want to use this modern engine. Alternatively, “ubODE” can be used, a version of ODE developed by Ubit Umarov. (The old original ODE is no longer recommended today.)

[Startup]
  ; physics = ubODE
  ; physics = BulletSim

If “ubODE” was chosen, a little upwards in the Ini-file also “ubODEMeshmerizer” must be selected instead of the default “Meshmerizer”.

[Startup]
  ;; select ubODEMeshmerizer only with ubOde physics engine
  ; meshing = ubODEMeshmerizer

This is the TCP port of OpenSim. Please do not confuse this with the UDP ports of the regions! One region can have quite the same port number, because TCP and UDP are different protocols and do not disturb each other. Default is 9000. If multiple instances of OpenSim are running with the same IP address, then the programs must use different TCP ports (and anyway each region a unique UDP port).

[Network]
  ; http_listener_port = 9000

Only required if scripts act as web server on the regions: The function llRequestURL requires the externally accessible web address or domain. By default this is commented out and thus the feature is switched off.

[Network]
  ; ExternalHostNameForLSL = "my.external.domain.or.ipv4.address"

If scripts with the function llHTTPRequest call web pages, the following string is given as browser identification. Why “Mozilla” makes sense is stated in the Second Life Wiki (below in the commentary).

[Network]
  user_agent = "OpenSim LSL (Mozilla Compatible)"

To send and receive IMs, URLs must be entered for the selected grid, and depending on the grid additional modules must be activated. Here are two commented out variants, for one of our sample grids the appropriate comment characters must be removed. Unfortunately, there are now many possible combinations of modules, so that the configuration of the selected grid must be requested in case of doubt!

[Messaging]
  OfflineMessageModule = "OfflineMessageModule"
  OfflineMessageURL = "http://im.osgrid.org/offline"

  ;; Use only one mute list module depending on the grid connected to!
  ;; Example for "OpenSimMuteList" as used in OSGrid.
  MuteListModule = "OpenSimMuteList"
  MuteListURL = "http://im.osgrid.org/mute/index.php"
  ;; Example using the internal "MuteListModule".
  ; MuteListModule = "MuteListModule"

“Windlight” are special lighting moods on the regions. To be able to send these to the visitors’ OpenSim viewers, Windlight must be activated. Default is “false”, for whatever reason.

[LightShare]
  enable_windlight = true

DataSnapshot and Search ensure that objects on your land can be marked for search. Here also settings fitting for the selected grid have to be made. Index_sims will turn on that feature. If search for objects is enabled in the server, periodical scans of the land are necessary and a list of objects is transmitted to the grid. For performance reasons it is recommended to increase the transmission interval of 20 minutes to 10 hours.

Note: If there are no vendors or copy-able objects on the regions, then “index_sims = false” can also be set (which is the default value). Then no objects are “advertised” if the copy check box in the permissions is set by mistake – but also no other objects.

[DataSnapshot]
  index_sims = true
  default_snapshot_period = 36000
  gridname = "OSGrid"
  data_services = "http://search.osgrid.org/register.php"

Only for grids which use the Module “OpenSimSearch”: The section “Search” is missing in the original sample file. Then simply add [Search] and the two lines as below with the URL adapted to the grid.

[Search]
  ;; Example for "OpenSimSearch" as used in OSGrid.
  Module = "OpenSimSearch"
  SearchURL = "http://search.osgrid.org/query.php"

In OpenSim 0.9.1, the OSSL configuration is in a separate file. By default, it is not selected, so all OSSL script functions would be disabled.

[OSSL]
  Include-osslEnable = "config-include/osslEnable.ini"

Only necessary for Voice-Chat: Latest Viewer support neither Mumble nor FreeSwitch without modification to the code. The company Vivox, which operates the voice service for Second Life amongst other things, offered uncomplicated agreements with OpenSim server operators since early 2012. Unfortunately, new contracts are no longer possible. (Default is “enabled = false”.)

[VivoxVoice]
  ; enabled = true
  ; vivox_server = www.foobar.vivox.com
  ; vivox_sip_uri = foobar.vivox.com
  ; vivox_admin_user = DeepThroat
  ; vivox_admin_password = VoiceG4te

Here grid specific one group function block is turned on and the appropriate module is enabled. Moreover, the correct URL for the selected grid has to be entered.

[Groups]
  ;; Example for grids using "Groups HG Service Connector",
  ;; "Groups HG Service Connector" and "Groups Messaging Module V2".
  ; Enabled = true
  ; Module = "Groups Module V2"
  ; ServicesConnectorModule = "Groups HG Service Connector"
  ; LocalService = remote
  ; GroupsServerURI = "http://groups.example.grid"
  ; GroupsExternalURI = "http://groups.example.grid"
  ; MessagingModule = "Groups Messaging Module V2"

  ;; Example for "GroupsModule", "XmlRpcGroupsServicesConnector"
  ;; and "Groups Messaging Module" as used in OSGrid.
  Enabled = true
  Module = GroupsModule
  ServicesConnectorModule = "XmlRpcGroupsServicesConnector"
  GroupsServerURI = "http://groups.osgrid.org/xmlrpc.php"
  MessagingModule = GroupsMessagingModule

NPC are scripted avatars. This option can be activated on a flat rate, even if it is currently not needed. The grids usually already have correspondingly limited privileges in the osslEnable.ini. Who is sure to need no NPC can omit setting this to true. (Default is false.)

[NPC]
  Enabled = true

Depending on the grid, choose the appropriate URL …

[UserProfiles]
  ProfileServiceURL = "http://services.osgrid.org"

Depending on the grid, choose the appropriate URL …

[XBakes]
  URL = "http://xbakes.osgrid.org"

Only in Grids with Maptile-Server: URL for retrieving maptiles from the hypergrid.

[SimulatorFeatures]
  ;; Example for a Grid with Maptile-Server, here OSGrid.
  MapTileURL = "http://maptiles.osgrid.org:80"

In keeping with the tutorial “GridHypergrid.ini” must be chosen, because here OpenSim is connected to a grid and Hypergrid is configured. Other architectures are only partially suitable for this manual!

[Architecture]
  Include-Architecture = "config-include/GridHypergrid.ini"

These were the necessary settings. A few pages further down some tuning tipps will follow.


Continued: Starting the OpenSim software for the first time

Scroll to Top