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

[Groups] (25 settings)

Group services and settings.

25 settings

DebugEnabled bool

Catalog value : false

Technical description (original English : This makes the Group module very chatty on the console.

Source code : OpenSim/Addons/Groups/GroupsModule.cs:93 | OpenSim/Region/OptionalModules/Avatar/XmlRpcGroups/GroupsModule.cs:117 | OpenSim/Region/OptionalModules/Avatar/XmlRpcGroups/XmlRpcGroupsServicesConnectorModule.cs:198

Shipped defaultsTemplate / example / testROBUST

Referenced files:

  • bin/OpenSimDefaults.ini — Shipped defaults
  • bin/OpenSim.ini.example — Template / example / test
  • bin/config-include/Proto/OsGrid/OpenSim.ini — Template / example / test
  • bin/config-include/Proto/Region/OpenSim.ini — Template / example / test
  • bin/config-include/Proto/Robust/OpenSim.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.

DebugMessagingEnabled

Catalog value : false

Technical description (original English : This makes the Groups Messaging module very chatty on the console. [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 :

Shipped defaultsTemplate / example / test

Referenced files:

  • bin/OpenSimDefaults.ini — Shipped defaults
  • bin/OpenSim.ini.example — Template / example / test
  • bin/config-include/Proto/Region/OpenSim.ini — Template / example / test
  • bin/config-include/Proto/Robust/OpenSim.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.

DefaultGroupID

Catalog value :

Technical description (original English : Default Groups - add avatar to default group. Only works with V2 groups. Ensure that GroupsService is set in [UserAccountService] section eg. (GroupsService = "OpenSim.Addons.Groups.dll:GroupsService") Set the DefaultGroupID to the UUID of the group Set the DefaultGroupRole to the name of the group role. Defaults to Everyone if not provided or if supplied role is not found. [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 / test

Referenced files:

  • bin/config-include/Proto/Region/OpenSim.ini — Template / example / test
  • bin/config-include/Proto/Robust/OpenSim.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.

DefaultGroupRole

Catalog value :

Technical description (original English : Default Groups - add avatar to default group. Only works with V2 groups. Ensure that GroupsService is set in [UserAccountService] section eg. (GroupsService = "OpenSim.Addons.Groups.dll:GroupsService") Set the DefaultGroupID to the UUID of the group Set the DefaultGroupRole to the name of the group role. Defaults to Everyone if not provided or if supplied role is not found. [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 / test

Referenced files:

  • bin/config-include/Proto/Region/OpenSim.ini — Template / example / test
  • bin/config-include/Proto/Robust/OpenSim.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.

Enabled bool

Catalog value : false

Technical description (original English : Enable groups?. Choices: true false. Default: false. Enables the groups module

Source code : OpenSim/Addons/Groups/GroupsMessagingModule.cs:98 | OpenSim/Addons/Groups/GroupsModule.cs:77 | OpenSim/Addons/Groups/Hypergrid/GroupsServiceHGConnectorModule.cs:76 | OpenSim/Addons/Groups/Local/GroupsServiceLocalConnectorModule.cs:84 | OpenSim/Addons/Groups/Remote/GroupsServiceRemoteConnectorModule.cs:89 | OpenSim/Region/CoreModules/Avatar/Groups/GroupsModule.cs:76 | OpenSim/Region/OptionalModules/Avatar/XmlRpcGroups/GroupsMessagingModule.cs:97 | OpenSim/Region/OptionalModules/Avatar/XmlRpcGroups/GroupsModule.cs:104 | OpenSim/Region/OptionalModules/Avatar/XmlRpcGroups/XmlRpcGroupsServicesConnectorModule.cs:165

Shipped defaultsTemplate / example / testROBUST

Referenced files:

  • bin/OpenSimDefaults.ini — Shipped defaults
  • bin/OpenSim.ini.example — Template / example / test
  • bin/config-include/Proto/OsGrid/OpenSim.ini — Template / example / test
  • bin/config-include/Proto/Region/OpenSim.ini — Template / example / test
  • bin/config-include/Proto/Robust/OpenSim.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.

GroupsCacheTimeout int

Catalog value : 30

Technical description (original English : Groups data is cached for this number of seconds before another request is made to the groups service Set to 0 to disable the cache. Default is 30 seconds

Source code : OpenSim/Region/OptionalModules/Avatar/XmlRpcGroups/XmlRpcGroupsServicesConnectorModule.cs:187

Shipped defaults

Referenced files:

  • bin/OpenSimDefaults.ini — Shipped defaults

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.

GroupsExternalURI string

Catalog value : http://127.0.0.1

Technical description (original English : Inferred from code: Address/URL for groups external uri. string (stored in m_LocalGroupsServiceLocation), read by GroupsServiceHGConnectorModule.

Source code : OpenSim/Addons/Groups/Hypergrid/GroupsServiceHGConnectorModule.cs:84

Template / example / test

Referenced files:

  • bin/config-include/Proto/Region/OpenSim.ini — Template / example / test
  • bin/config-include/Proto/Robust/OpenSim.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.

GroupsServerURI string

Catalog value : code: "" / ini: http://yourxmlrpcserver.com/xmlrpc.php

Technical description (original English : Flotsam XmlRpc Service for Groups

Source code : OpenSim/Addons/Groups/Remote/GroupsServiceRemoteConnector.cs:55 | OpenSim/Region/OptionalModules/Avatar/XmlRpcGroups/XmlRpcGroupsServicesConnectorModule.cs:174

Shipped defaultsTemplate / example / testROBUST

Referenced files:

  • bin/OpenSimDefaults.ini — Shipped defaults
  • bin/OpenSim.ini.example — Template / example / test
  • bin/config-include/Proto/OsGrid/OpenSim.ini — Template / example / test
  • bin/config-include/Proto/Region/OpenSim.ini — Template / example / test
  • bin/config-include/Proto/Robust/OpenSim.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.

HomeURI

Catalog value : ${Const|BaseURL}:${Const|PublicPort}

Technical description (original English : What's the home address of this world?. Depends on: ServicesConnectorModule:Groups HG Service Connector. http://mygridserver.com:9000 or http://mygridserver.com:8002 If you have this set in [Hypergrid] section of GridCommon.ini or StandaloneCommon.ini files in config-include folder, leave it commented [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/OpenSim.ini.example — Template / example / test
  • bin/Robust.HG.ini.example — Template / example / test
  • bin/config-include/Proto/Region/OpenSim.ini — Template / example / test
  • bin/config-include/Proto/Robust/OpenSim.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.

LevelGroupCreate int

Catalog value : 0

Technical description (original English : Minimum user level required to create groups

Source code : OpenSim/Addons/Groups/GroupsModule.cs:94 | OpenSim/Region/OptionalModules/Avatar/XmlRpcGroups/GroupsModule.cs:118

Shipped defaultsTemplate / example / test

Referenced files:

  • bin/OpenSimDefaults.ini — Shipped defaults
  • bin/OpenSim.ini.example — Template / example / test
  • bin/config-include/Proto/Region/OpenSim.ini — Template / example / test
  • bin/config-include/Proto/Robust/OpenSim.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.

LocalService string

Catalog value : local

Technical description (original English : Is the group service in this process or elsewhere?. Choices: local remote. Depends on: ServicesConnectorModule:Groups HG Service Connector. Default: local. Used for V2 in HG only. If standalone, set this to local; if grided sim, set this to remote

Source code : OpenSim/Addons/Groups/Hypergrid/GroupsServiceHGConnectorModule.cs:83

Template / example / test

Referenced files:

  • bin/OpenSim.ini.example — Template / example / test
  • bin/config-include/Proto/Region/OpenSim.ini — Template / example / test
  • bin/config-include/Proto/Robust/OpenSim.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.

MaxAgentGroups int

Catalog value : 42

Technical description (original English : Sets the maximum number of groups an agent may join

Source code : OpenSim/Services/LLLoginService/LLLoginService.cs:195

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

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.

MessageOnlineUsersOnly bool

Catalog value : false

Technical description (original English : Experimental option to only message cached online users rather than all users Should make large group with few online members messaging faster, at the expense of more calls to ROBUST presence service (Flotsam groups only; in V2 this is always on)

Source code : OpenSim/Addons/Groups/GroupsMessagingModule.cs:110 | OpenSim/Region/OptionalModules/Avatar/XmlRpcGroups/GroupsMessagingModule.cs:111

Shipped defaultsTemplate / example / test

Referenced files:

  • bin/OpenSimDefaults.ini — Shipped defaults
  • bin/OpenSim.ini.example — Template / example / test
  • bin/config-include/Proto/OsGrid/OpenSim.ini — Template / example / test
  • bin/config-include/Proto/Region/OpenSim.ini — Template / example / test
  • bin/config-include/Proto/Robust/OpenSim.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.

MessagingEnabled bool

Catalog value : true

Technical description (original English : Specify which messaging module to use for groups messaging and if it's enabled

Source code : OpenSim/Addons/Groups/GroupsMessagingModule.cs:105 | OpenSim/Region/OptionalModules/Avatar/XmlRpcGroups/GroupsMessagingModule.cs:104

Shipped defaultsTemplate / example / testROBUST

Referenced files:

  • bin/OpenSimDefaults.ini — Shipped defaults
  • bin/OpenSim.ini.example — Template / example / test
  • bin/config-include/Proto/OsGrid/OpenSim.ini — Template / example / test
  • bin/config-include/Proto/Region/OpenSim.ini — Template / example / test
  • bin/config-include/Proto/Robust/OpenSim.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.

MessagingModule string

Catalog value : code: "" / ini: GroupsMessagingModule, Groups Messaging Module V2

Technical description (original English : Specify which messaging module to use for groups messaging and if it's enabled

Source code : OpenSim/Addons/Groups/GroupsMessagingModule.cs:99 | OpenSim/Region/OptionalModules/Avatar/XmlRpcGroups/GroupsMessagingModule.cs:98

Shipped defaultsTemplate / example / testROBUST

Referenced files:

  • bin/OpenSimDefaults.ini — Shipped defaults
  • bin/OpenSim.ini.example — Template / example / test
  • bin/config-include/Proto/OsGrid/OpenSim.ini — Template / example / test
  • bin/config-include/Proto/Region/OpenSim.ini — Template / example / test
  • bin/config-include/Proto/Robust/OpenSim.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.

Module string

Catalog value : Default

Technical description (original English : This is the current groups stub in Region.CoreModules.Avatar.Groups. All the other settings below only really apply to the Flotsam GroupsModule

Source code : OpenSim/Addons/Groups/GroupsModule.cs:83 | OpenSim/Region/CoreModules/Avatar/Groups/GroupsModule.cs:83 | OpenSim/Region/OptionalModules/Avatar/XmlRpcGroups/GroupsModule.cs:108

Shipped defaultsTemplate / example / testROBUST

Referenced files:

  • bin/OpenSimDefaults.ini — Shipped defaults
  • bin/OpenSim.ini.example — Template / example / test
  • bin/config-include/Proto/OsGrid/OpenSim.ini — Template / example / test
  • bin/config-include/Proto/Region/OpenSim.ini — Template / example / test
  • bin/config-include/Proto/Robust/OpenSim.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.

NoticesEnabled bool

Catalog value : true

Technical description (original English : Enable Group Notices

Source code : OpenSim/Addons/Groups/GroupsModule.cs:92 | OpenSim/Region/OptionalModules/Avatar/XmlRpcGroups/GroupsModule.cs:116

Shipped defaultsTemplate / example / testROBUST

Referenced files:

  • bin/OpenSimDefaults.ini — Shipped defaults
  • bin/OpenSim.ini.example — Template / example / test
  • bin/config-include/Proto/OsGrid/OpenSim.ini — Template / example / test
  • bin/config-include/Proto/Region/OpenSim.ini — Template / example / test
  • bin/config-include/Proto/Robust/OpenSim.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.

OfflineIMService string

Catalog value : code: "" / ini: OpenSim.Addons.OfflineIM.dll:OfflineIMService

Technical description (original English : for the HG Groups service

Source code : OpenSim/Addons/Groups/Hypergrid/HGGroupsServiceRobustConnector.cs:78

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.

SecretKey string

Catalog value : ***

Technical description (original English : Secret key between sim and remote group service. Depends on: ServicesConnectorModule:Groups Remote Service Connector. Default: "". Used for V2 in Remote only.

Source code : OpenSim/Addons/Groups/Remote/GroupsServiceRobustConnector.cs:65

Template / example / test

Referenced files:

  • bin/OpenSim.ini.example — Template / example / test
  • bin/config-include/Proto/Region/OpenSim.ini — Template / example / test
  • bin/config-include/Proto/Robust/OpenSim.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.

ServicesConnectorModule string

Catalog value : code: "", XmlRpcGroupsServicesConnector / ini: XmlRpcGroupsServicesConnector

Technical description (original English : Flotsam XmlRpc Service for Groups

Source code : OpenSim/Addons/Groups/Hypergrid/GroupsServiceHGConnectorModule.cs:77 | OpenSim/Addons/Groups/Local/GroupsServiceLocalConnectorModule.cs:85 | OpenSim/Addons/Groups/Remote/GroupsServiceRemoteConnectorModule.cs:90 | OpenSim/Region/OptionalModules/Avatar/XmlRpcGroups/XmlRpcGroupsServicesConnectorModule.cs:166

Shipped defaultsTemplate / example / testROBUST

Referenced files:

  • bin/OpenSimDefaults.ini — Shipped defaults
  • bin/OpenSim.ini.example — Template / example / test
  • bin/config-include/Proto/OsGrid/OpenSim.ini — Template / example / test
  • bin/config-include/Proto/Region/OpenSim.ini — Template / example / test
  • bin/config-include/Proto/Robust/OpenSim.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.

StorageProvider

Catalog value : OpenSim.Data.MySQL.dll

Technical description (original English : The DLL that provides the storage for V2. Choices: OpenSim.Data.MySQL.dll. Depends on: Module:Groups Module V2. [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 / test

Referenced files:

  • bin/OpenSim.ini.example — Template / example / test
  • bin/config-include/Proto/Region/OpenSim.ini — Template / example / test
  • bin/config-include/Proto/Robust/OpenSim.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.

UserAccountService string

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

Technical description (original English : for the HG Groups service

Source code : OpenSim/Addons/Groups/Hypergrid/HGGroupsServiceRobustConnector.cs:88

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.

XmlRpcDisableKeepAlive bool

Catalog value : true

Technical description (original English : Disables HTTP Keep-Alive for XmlRpcGroupsServicesConnector HTTP Requests, only set to false if you absolutely sure regions and groups server supports it.

Source code : OpenSim/Region/OptionalModules/Avatar/XmlRpcGroups/XmlRpcGroupsServicesConnectorModule.cs:182

Shipped defaults

Referenced files:

  • bin/OpenSimDefaults.ini — Shipped defaults

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.

XmlRpcServiceReadKey string

Catalog value : ***

Technical description (original English : XmlRpc Security settings. These must match those set on your backend groups service if the service is using these keys

Source code : OpenSim/Region/OptionalModules/Avatar/XmlRpcGroups/XmlRpcGroupsServicesConnectorModule.cs:184

Shipped defaultsTemplate / example / test

Referenced files:

  • bin/OpenSimDefaults.ini — Shipped defaults
  • bin/OpenSim.ini.example — Template / example / test
  • bin/config-include/Proto/OsGrid/OpenSim.ini — Template / example / test
  • bin/config-include/Proto/Region/OpenSim.ini — Template / example / test
  • bin/config-include/Proto/Robust/OpenSim.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.

XmlRpcServiceWriteKey string

Catalog value : ***

Technical description (original English : XmlRpc Security settings. These must match those set on your backend groups service if the service is using these keys

Source code : OpenSim/Region/OptionalModules/Avatar/XmlRpcGroups/XmlRpcGroupsServicesConnectorModule.cs:185

Shipped defaultsTemplate / example / test

Referenced files:

  • bin/OpenSimDefaults.ini — Shipped defaults
  • bin/OpenSim.ini.example — Template / example / test
  • bin/config-include/Proto/OsGrid/OpenSim.ini — Template / example / test
  • bin/config-include/Proto/Region/OpenSim.ini — Template / example / test
  • bin/config-include/Proto/Robust/OpenSim.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.