OpenSimulator · EN

Browse INI sections

Dedicated section search, alphabetical index and detailed settings from the catalog.

This index only includes entries with an explicit INI-file reference in the catalog. Optional modules and example templates may still appear: always verify the source file before adding settings.

← Back to all sections

[GridService] (17 settings)

Region registration and lookup through grid services.

17 settings

AllowDuplicateNames bool

Catalog value : false

Technical description (original English : Inferred from code: If true, allow duplicate names. bool (stored in m_AllowDuplicateNames), read by GridService.

Source code : OpenSim/Services/GridService/GridService.cs:100

Template / example / testROBUST

Referenced files:

  • bin/Robust.HG.ini.example — Template / example / test
  • bin/Robust.ini.example — Template / example / test
  • bin/Robust.HG.ini — ROBUST
  • bin/Robust.HG.ini.proto — Template / example / test
  • bin/Robust.Tests.ini — Template / example / test

This is provenance, not active configuration. Edit only files loaded by your architecture. On a simulator check effective values with config show. .example files must be copied and customized before use.

AllowHypergridMapSearch bool

Catalog value : code: false / ini: true

Technical description (original English : Change this to your grid-wide grid server

Source code : OpenSim/Services/GridService/GridService.cs:101

Template / example / testIncluded configuration

Referenced files:

  • bin/config-include/GridCommon.ini.example — Template / example / test
  • bin/config-include/GridCommon-GridServer-JOpensim.ini — Included configuration
  • bin/config-include/GridCommon-GridServer.ini — Included configuration
  • bin/config-include/GridCommon-OsGridServer.ini — Included configuration
  • bin/config-include/GridCommon-RegionServer.ini — Included configuration
  • bin/config-include/GridCommon.ini — Included configuration
  • bin/config-include/GridHypergrid.ini — Included configuration
  • bin/config-include/Proto/Joomla/GridCommon.ini — Template / example / test
  • bin/config-include/Proto/OsGrid/GridCommon.ini — Template / example / test
  • bin/config-include/Proto/OsGrid/GridHypergrid.ini — Template / example / test
  • bin/config-include/Proto/Region/GridCommon.ini — Template / example / test
  • bin/config-include/Proto/Region/GridHypergrid.ini — Template / example / test
  • bin/config-include/Proto/Robust/GridCommon.ini — Template / example / test
  • bin/config-include/Proto/Robust/GridHypergrid.ini — Template / example / test
  • bin/config-include/StandaloneHypergrid.ini — Included configuration

This is provenance, not active configuration. Edit only files loaded by your architecture. On a simulator check effective values with config show. .example files must be copied and customized before use.

AssetService string

Catalog value : code: "" / ini: OpenSim.Services.AssetService.dll:AssetService

Technical description (original English : Needed to display non-default map tile images for linked regions

Source code : OpenSim/Services/GridService/HypergridLinker.cs:77

Template / example / testIncluded configurationROBUST

Referenced files:

  • bin/Robust.HG.ini.example — Template / example / test
  • bin/config-include/GridHypergrid.ini — Included configuration
  • bin/config-include/Proto/OsGrid/GridHypergrid.ini — Template / example / test
  • bin/config-include/Proto/Region/GridHypergrid.ini — Template / example / test
  • bin/config-include/Proto/Robust/GridHypergrid.ini — Template / example / test
  • bin/config-include/StandaloneHypergrid.ini — Included configuration
  • bin/Robust.HG.ini — ROBUST
  • bin/Robust.HG.ini.proto — Template / example / test

This is provenance, not active configuration. Edit only files loaded by your architecture. On a simulator check effective values with config show. .example files must be copied and customized before use.

Check4096

Catalog value : True

Technical description (original English : Perform distance check for the creation of a linked region [Appears only in INI files; no literal read found in C# (may be read via a dynamic key, by another program, or obsolete).]

Source code :

Template / example / testROBUST

Referenced files:

  • bin/Robust.HG.ini.example — Template / example / test
  • bin/Robust.HG.ini — ROBUST
  • bin/Robust.HG.ini.proto — Template / example / test

This is provenance, not active configuration. Edit only files loaded by your architecture. On a simulator check effective values with config show. .example files must be copied and customized before use.

ExportSupported string

Catalog value : true

Technical description (original English : Allow supporting viewers to export content Set to false to prevent export

Source code : OpenSim/Services/GridService/GridService.cs:252

Template / example / testROBUST

Referenced files:

  • bin/Robust.HG.ini.example — Template / example / test
  • bin/Robust.ini.example — Template / example / test
  • bin/config-include/StandaloneCommon.ini.example — Template / example / test
  • bin/Robust.HG.ini — ROBUST
  • bin/Robust.HG.ini.proto — Template / example / test
  • bin/Robust.Tests.ini — Template / example / test

This is provenance, not active configuration. Edit only files loaded by your architecture. On a simulator check effective values with config show. .example files must be copied and customized before use.

Gatekeeper string

Catalog value : code: "" / ini: ${Const|BaseURL}:${Const|PublicPort}

Technical description (original English : === HG ONLY === Change this to the address of your Gatekeeper service (usually bundled with the rest of the services in one Robust server in port ${Const|PublicPort}, but not always)

Source code : OpenSim/Framework/GridInfo.cs:390 | OpenSim/Region/OptionalModules/DataSnapshot/DataSnapshotManager.cs:123

Template / example / testIncluded configuration

Referenced files:

  • bin/config-include/GridCommon.ini.example — Template / example / test
  • bin/config-include/GridCommon-GridServer-JOpensim.ini — Included configuration
  • bin/config-include/GridCommon-GridServer.ini — Included configuration
  • bin/config-include/GridCommon-OsGridServer.ini — Included configuration
  • bin/config-include/GridCommon-RegionServer.ini — Included configuration
  • bin/config-include/GridCommon.ini — Included configuration
  • bin/config-include/Proto/Joomla/GridCommon.ini — Template / example / test
  • bin/config-include/Proto/OsGrid/GridCommon.ini — Template / example / test
  • bin/config-include/Proto/Region/GridCommon.ini — Template / example / test
  • bin/config-include/Proto/Robust/GridCommon.ini — Template / example / test

This is provenance, not active configuration. Edit only files loaded by your architecture. On a simulator check effective values with config show. .example files must be copied and customized before use.

GatekeeperURI string

Catalog value : code: "" / ini: ${Const|BaseURL}:${Const|PublicPort}

Technical description (original English : If you have this set under [Hypergrid], no need to set it here, leave it commented [Also looked up in: Hypergrid, Startup (later sections override earlier).]

Source code : OpenSim/Region/OptionalModules/DataSnapshot/DataSnapshotManager.cs:116

Template / example / testROBUST

Referenced files:

  • bin/Robust.HG.ini.example — Template / example / test
  • bin/Robust.HG.ini — ROBUST
  • bin/Robust.HG.ini.proto — Template / example / test

This is provenance, not active configuration. Edit only files loaded by your architecture. On a simulator check effective values with config show. .example files must be copied and customized before use.

GridServerURI string

Catalog value : code: "" / ini: ${Const|PrivURL}:${Const|PrivatePort}

Technical description (original English : Change this to your grid-wide grid server

Source code : OpenSim/Services/Connectors/Grid/GridServicesConnector.cs:72

Template / example / testIncluded configuration

Referenced files:

  • bin/config-include/GridCommon.ini.example — Template / example / test
  • bin/config-include/GridCommon-GridServer-JOpensim.ini — Included configuration
  • bin/config-include/GridCommon-GridServer.ini — Included configuration
  • bin/config-include/GridCommon-OsGridServer.ini — Included configuration
  • bin/config-include/GridCommon-RegionServer.ini — Included configuration
  • bin/config-include/GridCommon.ini — Included configuration
  • bin/config-include/Proto/Joomla/GridCommon.ini — Template / example / test
  • bin/config-include/Proto/OsGrid/GridCommon.ini — Template / example / test
  • bin/config-include/Proto/Region/GridCommon.ini — Template / example / test
  • bin/config-include/Proto/Robust/GridCommon.ini — Template / example / test

This is provenance, not active configuration. Edit only files loaded by your architecture. On a simulator check effective values with config show. .example files must be copied and customized before use.

HypergridLinker bool

Catalog value : code: false / ini: true

Technical description (original English : Allow Hyperlinks to be created at the console

Source code : OpenSim/Services/GridService/HypergridLinker.cs:70

Template / example / testIncluded configurationROBUST

Referenced files:

  • bin/Robust.HG.ini.example — Template / example / test
  • bin/config-include/GridHypergrid.ini — Included configuration
  • bin/config-include/Proto/OsGrid/GridHypergrid.ini — Template / example / test
  • bin/config-include/Proto/Region/GridHypergrid.ini — Template / example / test
  • bin/config-include/Proto/Robust/GridHypergrid.ini — Template / example / test
  • bin/config-include/StandaloneHypergrid.ini — Included configuration
  • bin/Robust.HG.ini — ROBUST
  • bin/Robust.HG.ini.proto — Template / example / test

This is provenance, not active configuration. Edit only files loaded by your architecture. On a simulator check effective values with config show. .example files must be copied and customized before use.

LocalServiceModule string

Catalog value : code: "" / ini: OpenSim.Services.GridService.dll:GridService

Technical description (original English : RemoteGridServicesConnector instantiates a LocalGridServicesConnector, which in turn uses this

Source code : OpenSim/Region/CoreModules/ServiceConnectorsOut/Grid/RegionGridServiceConnector.cs:108 | OpenSim/Server/Handlers/Grid/GridInfoHandlers.cs:92 | OpenSim/Server/Handlers/Grid/GridServerConnector.cs:50

Template / example / testIncluded configurationROBUST

Referenced files:

  • bin/Robust.HG.ini.example — Template / example / test
  • bin/Robust.ini.example — Template / example / test
  • bin/config-include/Grid.ini — Included configuration
  • bin/config-include/GridHypergrid.ini — Included configuration
  • bin/config-include/Proto/OsGrid/Grid.ini — Template / example / test
  • bin/config-include/Proto/OsGrid/GridHypergrid.ini — Template / example / test
  • bin/config-include/Proto/Region/Grid.ini — Template / example / test
  • bin/config-include/Proto/Region/GridHypergrid.ini — Template / example / test
  • bin/config-include/Proto/Robust/Grid.ini — Template / example / test
  • bin/config-include/Proto/Robust/GridHypergrid.ini — Template / example / test
  • bin/config-include/Standalone.ini — Included configuration
  • bin/config-include/StandaloneHypergrid.ini — Included configuration
  • bin/Robust.HG.ini — ROBUST
  • bin/Robust.HG.ini.proto — Template / example / test
  • bin/Robust.Tests.ini — Template / example / test

This is provenance, not active configuration. Edit only files loaded by your architecture. On a simulator check effective values with config show. .example files must be copied and customized before use.

MapTileDirectory string

Catalog value : code: maptiles / ini: ./maptiles

Technical description (original English : Directory for map tile images of linked regions

Source code : OpenSim/Services/GridService/HypergridLinker.cs:86

Template / example / testIncluded configurationROBUST

Referenced files:

  • bin/Robust.HG.ini.example — Template / example / test
  • bin/config-include/GridCommon.ini.example — Template / example / test
  • bin/config-include/StandaloneCommon.ini.example — Template / example / test
  • bin/config-include/GridCommon-GridServer-JOpensim.ini — Included configuration
  • bin/config-include/GridCommon-GridServer.ini — Included configuration
  • bin/config-include/GridCommon-OsGridServer.ini — Included configuration
  • bin/config-include/GridCommon-RegionServer.ini — Included configuration
  • bin/config-include/GridCommon.ini — Included configuration
  • bin/config-include/Proto/Joomla/GridCommon.ini — Template / example / test
  • bin/config-include/Proto/OsGrid/GridCommon.ini — Template / example / test
  • bin/config-include/Proto/Region/GridCommon.ini — Template / example / test
  • bin/config-include/Proto/Robust/GridCommon.ini — Template / example / test
  • bin/Robust.HG.ini — ROBUST
  • bin/Robust.HG.ini.proto — Template / example / test

This is provenance, not active configuration. Edit only files loaded by your architecture. On a simulator check effective values with config show. .example files must be copied and customized before use.

NetworkConnector string

Catalog value : ""

Technical description (original English : for the LocalGridServicesConnector which is used by the Remote one

Source code : OpenSim/Region/CoreModules/ServiceConnectorsOut/Grid/RegionGridServiceConnector.cs:124

Included configurationTemplate / example / test

Referenced files:

  • bin/config-include/Grid.ini — Included configuration
  • bin/config-include/GridHypergrid.ini — Included configuration
  • bin/config-include/Proto/OsGrid/Grid.ini — Template / example / test
  • bin/config-include/Proto/OsGrid/GridHypergrid.ini — Template / example / test
  • bin/config-include/Proto/Region/Grid.ini — Template / example / test
  • bin/config-include/Proto/Region/GridHypergrid.ini — Template / example / test
  • bin/config-include/Proto/Robust/Grid.ini — Template / example / test
  • bin/config-include/Proto/Robust/GridHypergrid.ini — Template / example / test

This is provenance, not active configuration. Edit only files loaded by your architecture. On a simulator check effective values with config show. .example files must be copied and customized before use.

Realm string

Catalog value : regions

Technical description (original English : Inferred from code: Sets realm. string (stored in realm), read by GridServiceBase.

Source code : OpenSim/Services/GridService/GridServiceBase.cs:66

Template / example / testIncluded configurationROBUST

Referenced files:

  • bin/Robust.HG.ini.example — Template / example / test
  • bin/Robust.ini.example — Template / example / test
  • bin/config-include/Standalone.ini — Included configuration
  • bin/config-include/StandaloneHypergrid.ini — Included configuration
  • bin/Robust.HG.ini — ROBUST
  • bin/Robust.HG.ini.proto — Template / example / test
  • bin/Robust.Tests.ini — Template / example / test

This is provenance, not active configuration. Edit only files loaded by your architecture. On a simulator check effective values with config show. .example files must be copied and customized before use.

Region_<RegionName>

Catalog value : DefaultRegion, DefaultHGRegion, DefaultRegion

Technical description (original English : Next, we can specify properties of regions, including default and fallback regions The syntax is: Region_<RegionName> = "<flags>" or: Region_<RegionID> = "<flags>" where <flags> can be DefaultRegion, DefaultHGRegion, FallbackRegion, NoDirectLogin, Persistent, LockedOut, Reservation, NoMove, Authenticate DefaultRegion If a local login cannot be placed in the required region (e.g. home region does not exist, avatar is not allowed entry, etc.) then this region becomes the destination. Only the first online default region will be used. If no DefaultHGRegion is specified then this will also be used as the region for hypergrid connections that require it (commonly because they have not specified an explicit region. DefaultHGRegion If an avatar connecting via the hypergrid does not specify a region, then they are placed here. Only the first online region will be used. FallbackRegion If the DefaultRegion is not available for a local login, then any FallbackRegions are tried instead. These are tried in the order specified. This only applies to local logins at this time, not Hypergrid connections. NoDirectLogin A hypergrid user cannot directly connect to this region. This does not apply to local logins. Persistent When the simulator is shutdown, the region is signalled as offline but left registered on the grid. Example specification: [Appears only in INI files; no literal read found in C# (may be read via a dynamic key, by another program, or obsolete). One key per region, read dynamically; value is a comma list of region flags.]

Source code :

Template / example / testROBUST

Referenced files:

  • bin/Robust.HG.ini.example — Template / example / test
  • bin/Robust.ini.example — Template / example / test
  • bin/config-include/StandaloneCommon.ini.example — Template / example / test
  • bin/Robust.HG.ini — ROBUST
  • bin/Robust.Tests.ini — Template / example / test

This is provenance, not active configuration. Edit only files loaded by your architecture. On a simulator check effective values with config show. .example files must be copied and customized before use.

RegionsAutoRegistration bool

Catalog value : code: true / ini: false

Technical description (original English : by default a unknown region is automatically added to the grid when it starts uncomment and set this to false to disable that in that case you will need to add regions to gridservice db by other means see warning on DeleteOnUnregister before changing.

Source code : OpenSim/Services/GridService/GridService.cs:89

Template / example / test

Referenced files:

  • bin/Robust.HG.ini.example — Template / example / test
  • bin/Robust.ini.example — Template / example / test

This is provenance, not active configuration. Edit only files loaded by your architecture. On a simulator check effective values with config show. .example files must be copied and customized before use.

StorageProvider string

Catalog value : code: "" / ini: OpenSim.Data.Null.dll:NullRegionData, Diva.Data.SQLite.dll, OpenSim.Data.MySQL.dll:MySqlRegionData

Technical description (original English : default standalone, overridable in StandaloneCommon.ini

Source code : OpenSim/Services/GridService/GridServiceBase.cs:64

Shipped defaultsTemplate / example / testIncluded configuration

Referenced files:

  • bin/OpenSimDefaults.ini — Shipped defaults
  • addon-modules/21Wifi/WifiSQLite.ini.example — Template / example / test
  • bin/config-include/StandaloneCommon.ini.example — Template / example / test
  • bin/config-include/Grid.ini — Included configuration
  • bin/config-include/GridHypergrid.ini — Included configuration
  • bin/config-include/Proto/OsGrid/Grid.ini — Template / example / test
  • bin/config-include/Proto/OsGrid/GridHypergrid.ini — Template / example / test
  • bin/config-include/Proto/Region/Grid.ini — Template / example / test
  • bin/config-include/Proto/Region/GridHypergrid.ini — Template / example / test
  • bin/config-include/Proto/Robust/Grid.ini — Template / example / test
  • bin/config-include/Proto/Robust/GridHypergrid.ini — Template / example / test
  • bin/config-include/Standalone.ini — Included configuration
  • bin/config-include/StandaloneHypergrid.ini — Included configuration

This is provenance, not active configuration. Edit only files loaded by your architecture. On a simulator check effective values with config show. .example files must be copied and customized before use.

SuppressConsoleCommands bool

Catalog value : false

Technical description (original English : Because LocalGridServicesConnector starts this service, in grid mode we need to suppress the inappropriate console commands that it registers.

Source code : OpenSim/Services/GridService/GridService.cs:105

Included configurationTemplate / example / test

Referenced files:

  • bin/config-include/Grid.ini — Included configuration
  • bin/config-include/GridHypergrid.ini — Included configuration
  • bin/config-include/Proto/OsGrid/Grid.ini — Template / example / test
  • bin/config-include/Proto/OsGrid/GridHypergrid.ini — Template / example / test
  • bin/config-include/Proto/Region/Grid.ini — Template / example / test
  • bin/config-include/Proto/Region/GridHypergrid.ini — Template / example / test
  • bin/config-include/Proto/Robust/Grid.ini — Template / example / test
  • bin/config-include/Proto/Robust/GridHypergrid.ini — Template / example / test

This is provenance, not active configuration. Edit only files loaded by your architecture. On a simulator check effective values with config show. .example files must be copied and customized before use.