Merge branch 'master' into careminster-presence-refactor

3 files changed, 89 insertions, 79 deletions

diff --git a/bin/OpenSim.ini.example b/bin/OpenSim.ini.example
index cf9e217..674a454 100644
--- a/bin/OpenSim.ini.example
+++ b/bin/OpenSim.ini.example
@@ -300,7 +300,7 @@
 
     ; What is reported as the "X-Secondlife-Shard"
     ; Defaults to the user server url if not set
-    ; The old default is "OpenSim", set here fro compatibility
+    ; The old default is "OpenSim", set here for compatibility
     shard = "OpenSim"
 
     ; What is reported as the "User-Agent" when using llHTTPRequest
@@ -309,6 +309,18 @@
     ; " (Mozilla Compatible)" to the text where there are problems with a web server
     ;user_agent = "OpenSim LSL (Mozilla Compatible)"
 
+[XMLRPC]
+    ; ##
+    ; ## Scripting XMLRPC mapper
+    ; ##
+
+    ; If enabled, this will post an event, "xmlrpc_uri(string)" to the
+    ; script concurrently with the first remote_data event.
+    ; This will contain the fully qualified URI an external site needs
+    ; to use to send XMLRPC requests to that script
+
+    ;XmlRpcRouterModule = "XmlRpcRouterModule"
+    ;XmlRpcPort = 20800
 
 [ClientStack.LindenUDP]
     ; Set this to true to process incoming packets asynchronously. Networking is
@@ -1180,37 +1192,38 @@ UseSafetyCommit = true
     ;vivox_channel_clamping_distance = 10
 
 [FreeSwitchVoice]
-    ; In order for this to work you need a functioning freeswitch pbx set
-    ; up.  Configuration for that will be posted in the wiki soon.
+    ; In order for this to work you need a functioning FreeSWITCH PBX set up.
+    ; Configuration details at http://opensimulator.org/wiki/Freeswitch_Module
     enabled = false
-    ;FreeSwitch server is going to contact us and ask us all
-    ;sorts of things.
+    ; FreeSWITCH server is going to contact us and ask us all sorts of things
     freeswitch_server_user = freeswitch
     freeswitch_server_pass = password
     freeswitch_api_prefix = /api
-    ; this is the IP of your sim
+    ; external IP address of your OpenSim voice enabled region
+    ; note: all regions running on same OpenSim.exe will be enabled
     freeswitch_service_server = ip.address.of.your.sim
-    ;freeswitch_service_port = 80
     ; this should be the same port the region listens on
     freeswitch_service_port = 9000
     freeswitch_realm = ip.address.of.freeswitch.server
     freeswitch_sip_proxy = ip.address.of.freeswitch.server:5060
+    ; STUN = Simple Traversal of UDP through NATs
+    ; See http://wiki.freeswitch.org/wiki/NAT_Traversal
+    ; stun.freeswitch.org is not guaranteed to be running so use it in production at your own risk
     freeswitch_attempt_stun = false
-    freeswitch_stun_server = ip.address.of.freeswitch.server
+    freeswitch_stun_server = ip.address.of.stun.server
     freeswitch_echo_server = ip.address.of.freeswitch.server
     freeswitch_echo_port = 50505
     freeswitch_well_known_ip = ip.address.of.freeswitch.server
-
-    ;Type the address of your http server here, hostname is allowed.  This is provided so you can specify a hostname
-    ;This is used by client for account verification.  By default, it's the same as the freeswitch service server.
-
-    ;opensim_well_known_http_address = Address_Of_your_SIM_HTTP_Server_Hostname_Allowed
-
+    ;
+    ; Type the address of your http server here, hostname is allowed.  This is provided so you can specify a hostname
+    ; This is used by client for account verification.  By default, it's the same as the freeswitch service server.
+    ;
+    ; opensim_well_known_http_address = Address_Of_Your_SIM_HTTP_Server_Hostname_Allowed
+    ;
     freeswitch_default_timeout = 5000
     freeswitch_subscribe_retry = 120
     ; freeswitch_password_reset_url =
 
-
 [Groups]
     Enabled = false
 
@@ -1331,16 +1344,8 @@ Message = "The MOTD module is working!"
 [Modules]
     Include-modules = "addon-modules/*/config/*.ini"
 
-[XMLRPC]
-    ; ##
-    ; ## Scripting XMLRPC mapper
-    ; ##
-
-    ; If enabled, this will post an event, "xmlrpc_uri(string)" to the
-    ; script concurrently with the first remote_data event.
-    ; This will contain the fully qualified URI an external site needs
-    ; to use to send XMLRPC requests to that script
-
-    ;XmlRpcRouterModule = "XmlRpcRouterModule"
-    ;XmlRpcPort = 20800
 
+;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
+;; ENSURE [Architecture] and [Modules] Sections with their "includes"
+;; are last to allow for overrides
+;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
diff --git a/bin/Robust.HG.ini.example b/bin/Robust.HG.ini.example
index 15b4d39..122ba2e 100644
--- a/bin/Robust.HG.ini.example
+++ b/bin/Robust.HG.ini.example
@@ -1,15 +1,25 @@
-;; Configurations for enabling HG1.5
-;; 
-;; Run
-;; $ Robust.exe -inifile Robust.HG.ini
-
-;; HG1.5 handlers are: OpenSim.Server.Handlers.dll:GatekeeperService
-;;                     OpenSim.Server.Handlers.dll:UserAgentService
-;; Additional OpenSim.Server.Handlers.dll:AssetServiceConnector and 
-;;            OpenSim.Server.Handlers.dll:XInventoryInConnector 
-;; are started in port 8002, outside the firewall
-;;
+; * Run
+; * $ Robust.exe -inifile Robust.HG.ini
+; *
 
+; * Configurations for enabling HG1.5
+; * 
+; * HG1.5 handlers are: OpenSim.Server.Handlers.dll:GatekeeperService
+; *                     OpenSim.Server.Handlers.dll:UserAgentService
+; * Additional OpenSim.Server.Handlers.dll:AssetServiceConnector and 
+; *            OpenSim.Server.Handlers.dll:XInventoryInConnector 
+; * are started in port 8002, outside the firewall
+; *
+; * The startup section lists all the connectors to start up in this server
+; * instance. This may be only one, or it may be the entire server suite.
+; * Multiple connectors should be separated by commas.
+; *
+; * These are the IN connectors the server uses, the in connectors
+; * read this config file and load the needed service and database connectors
+; *
+; * The full syntax of a connector string is:
+; * [[<ConfigName>@]<port>/]<dll name>[:<class name>]
+; *
 [Startup]
 ServiceConnectors = "8003/OpenSim.Server.Handlers.dll:AssetServiceConnector,8003/OpenSim.Server.Handlers.dll:XInventoryInConnector,8002/OpenSim.Server.Handlers.dll:FreeswitchServerConnector,8003/OpenSim.Server.Handlers.dll:GridServiceConnector,8002/OpenSim.Server.Handlers.dll:GridInfoServerInConnector,8003/OpenSim.Server.Handlers.dll:AuthenticationServiceConnector,8002/OpenSim.Server.Handlers.dll:OpenIdServerConnector,8003/OpenSim.Server.Handlers.dll:AvatarServiceConnector,8002/OpenSim.Server.Handlers.dll:LLLoginServiceInConnector,8003/OpenSim.Server.Handlers.dll:PresenceServiceConnector,8003/OpenSim.Server.Handlers.dll:UserAccountServiceConnector,8003/OpenSim.Server.Handlers.dll:GridUserServiceConnector,8003/OpenSim.Server.Handlers.dll:FriendsServiceConnector,8002/OpenSim.Server.Handlers.dll:GatekeeperServiceInConnector,8002/OpenSim.Server.Handlers.dll:UserAgentServerConnector,HGInventoryService@8002/OpenSim.Server.Handlers.dll:XInventoryInConnector,8002/OpenSim.Server.Handlers.dll:AssetServiceConnector"
 
@@ -52,10 +62,10 @@ ServiceConnectors = "8003/OpenSim.Server.Handlers.dll:AssetServiceConnector,8003
 ; *
 [GridService]
     LocalServiceModule = "OpenSim.Services.GridService.dll:GridService"
-    Realm = "regions"
+    ; Realm = "regions"
     ; AllowDuplicateNames = "True"
     ; Check4096 = "False"
-    
+
     ;; Next, we can specify properties of regions, including default and fallback regions
     ;; The syntax is: Region_<RegionName> = "<flags>"
     ;; or:            Region_<RegionID> = "<flags>"
@@ -70,12 +80,13 @@ ServiceConnectors = "8003/OpenSim.Server.Handlers.dll:AssetServiceConnector,8003
 
 ; * This is the new style authentication service. Currently, only MySQL
 ; * is implemented. "Realm" is the table that is used for user lookup.
-; * By setting it to "users", you can use the old style users table
-; * as an authentication source.
+; * It defaults to "useraccounts", which uses the new style.
+; * Realm = "users" will use the legacy tables as an authentication source
 ; *
 [AuthenticationService]
     ; for the server connector
     LocalServiceModule = "OpenSim.Services.AuthenticationService.dll:PasswordAuthenticationService"
+    ; Realm = "useraccounts"
 
 [OpenIdService]
     ; for the server connector
@@ -89,7 +100,9 @@ ServiceConnectors = "8003/OpenSim.Server.Handlers.dll:AssetServiceConnector,8003
 [UserAccountService]
     ; for the server connector
     LocalServiceModule = "OpenSim.Services.UserAccountService.dll:UserAccountService"
-    ;; These are for creating new accounts by the service
+    ; Realm = "usersaccounts"
+
+    ; These are for creating new accounts by the service
     AuthenticationService = "OpenSim.Services.AuthenticationService.dll:PasswordAuthenticationService"
     PresenceService = "OpenSim.Services.PresenceService.dll:PresenceService"
     GridService = "OpenSim.Services.GridService.dll:GridService"
@@ -161,32 +174,25 @@ ServiceConnectors = "8003/OpenSim.Server.Handlers.dll:AssetServiceConnector,8003
 
     ; login page: optional: if it exists it will be used to tell the client to use
     ;                       this as splash page
-    ; currently unused
     ;welcome = http://127.0.0.1/welcome
 
     ; helper uri: optional: if it exists if will be used to tell the client to use
     ;                       this for all economy related things
-    ; currently unused
     ;economy = http://127.0.0.1:9000/
 
     ; web page of grid: optional: page providing further information about your grid
-    ; currently unused
     ;about = http://127.0.0.1/about/
 
     ; account creation: optional: page providing further information about obtaining
     ;                             a user account on your grid
-    ; currently unused
     ;register = http://127.0.0.1/register
 
     ; help: optional: page providing further assistance for users of your grid
-    ; currently unused
     ;help = http://127.0.0.1/help
 
     ; password help: optional: page providing password assistance for users of your grid
-    ; currently unused
     ;password = http://127.0.0.1/password
 
-
 [GatekeeperService]
     LocalServiceModule = "OpenSim.Services.HypergridService.dll:GatekeeperService"
     ;; for the service
@@ -200,9 +206,9 @@ ServiceConnectors = "8003/OpenSim.Server.Handlers.dll:AssetServiceConnector,8003
     ; CHANGE THIS
     ExternalName = "http://127.0.0.1:8002"
 
-        ; Does this grid allow incoming links to any region in it? 
-        ; If false, HG TPs happen only to the  Default regions specified in [GridService] section
-        AllowTeleportsToAnyRegion = true
+    ; Does this grid allow incoming links to any region in it? 
+    ; If false, HG TPs happen only to the Default regions specified in [GridService] section
+    AllowTeleportsToAnyRegion = true
 
 [UserAgentService]
     LocalServiceModule = "OpenSim.Services.HypergridService.dll:UserAgentService"
@@ -211,12 +217,12 @@ ServiceConnectors = "8003/OpenSim.Server.Handlers.dll:AssetServiceConnector,8003
     GridService = "OpenSim.Services.GridService.dll:GridService"
     GatekeeperService = "OpenSim.Services.HypergridService.dll:GatekeeperService"
 
-;; The interface that local users get when they are in other grids.
-;; This restricts the inventory operations while in other grids.
-;; Still not completely safe, especially if users perform inventory operations 
-;; while in those grids. The more the user accesses his/her inventory, the more
-;; those simulators will know about the user's inventory.
+; * The interface that local users get when they are in other grids.
+; * This restricts the inventory operations while in other grids.
+; * Still not completely safe, especially if users perform inventory operations 
+; * while in those grids. The more the user accesses his/her inventory, the more
+; * those simulators will know about the user's inventory.
+; * 
 [HGInventoryService]
     ; For the InventoryServiceInConnector
-    LocalServiceModule    = "OpenSim.Services.InventoryService.dll:HGInventoryService"
-
+    LocalServiceModule = "OpenSim.Services.InventoryService.dll:HGInventoryService"
diff --git a/bin/Robust.ini.example b/bin/Robust.ini.example
index 96dfc01..0353eec 100644
--- a/bin/Robust.ini.example
+++ b/bin/Robust.ini.example
@@ -1,16 +1,18 @@
+; * Run
+; * $ Robust.exe -inifile Robust.ini
+; *
+
 ; * The startup section lists all the connectors to start up in this server
 ; * instance. This may be only one, or it may be the entire server suite.
-; * Multiple connectors should be seaprated by commas.
-; * The startup section lists all the connectors to start up in this server
-; * instance. This may be only one, or it may be the entire server suite.
-; * Multiple connectors should be seaprated by commas.
+; * Multiple connectors should be separated by commas.
 ; *
 ; * These are the IN connectors the server uses, the in connectors
 ; * read this config file and load the needed service and database connectors
 ; *
+; *  The full syntax of a connector string is:
+; * [[<ConfigName>@]<port>/]<dll name>[:<class name>]
 ; *
 [Startup]
-
 ServiceConnectors = "8003/OpenSim.Server.Handlers.dll:AssetServiceConnector,8003/OpenSim.Server.Handlers.dll:XInventoryInConnector,8002/OpenSim.Server.Handlers.dll:FreeswitchServerConnector,8003/OpenSim.Server.Handlers.dll:GridServiceConnector,8002/OpenSim.Server.Handlers.dll:GridInfoServerInConnector,8003/OpenSim.Server.Handlers.dll:AuthenticationServiceConnector,8002/OpenSim.Server.Handlers.dll:OpenIdServerConnector,8003/OpenSim.Server.Handlers.dll:AvatarServiceConnector,8002/OpenSim.Server.Handlers.dll:LLLoginServiceInConnector,8003/OpenSim.Server.Handlers.dll:PresenceServiceConnector,8003/OpenSim.Server.Handlers.dll:UserAccountServiceConnector,8003/OpenSim.Server.Handlers.dll:GridUserServiceConnector,8003/OpenSim.Server.Handlers.dll:FriendsServiceConnector"
 
 ; * This is common for all services, it's the network setup for the entire
@@ -30,7 +32,6 @@ ServiceConnectors = "8003/OpenSim.Server.Handlers.dll:AssetServiceConnector,8003
     StorageProvider = "OpenSim.Data.MySQL.dll"
     ConnectionString = "Data Source=localhost;Database=opensim;User ID=opensim;Password=*****;Old Guids=true;"
 
-
 ; * As an example, the below configuration precisely mimicks the legacy
 ; * asset server. It is read by the asset IN connector (defined above)
 ; * and it then loads the OUT connector (a local database module). That,
@@ -54,8 +55,10 @@ ServiceConnectors = "8003/OpenSim.Server.Handlers.dll:AssetServiceConnector,8003
 ; *
 [GridService]
     LocalServiceModule = "OpenSim.Services.GridService.dll:GridService"
-    Realm = "regions"
+    ; Realm = "regions"
     ; AllowDuplicateNames = "True"
+    ; Check4096 = "False"
+
     ;; Next, we can specify properties of regions, including default and fallback regions
     ;; The syntax is: Region_<RegionName> = "<flags>"
     ;; or:            Region_<RegionID> = "<flags>"
@@ -70,8 +73,8 @@ ServiceConnectors = "8003/OpenSim.Server.Handlers.dll:AssetServiceConnector,8003
 
 ; * This is the new style authentication service. Currently, only MySQL
 ; * is implemented. "Realm" is the table that is used for user lookup.
-; * By setting it to "users", you can use the old style users table
-; * as an authentication source.
+; * It defaults to "users", which uses the legacy tables as an
+; * authentication source.
 ; *
 [AuthenticationService]
     ; for the server connector
@@ -82,15 +85,17 @@ ServiceConnectors = "8003/OpenSim.Server.Handlers.dll:AssetServiceConnector,8003
     AuthenticationServiceModule = "OpenSim.Services.AuthenticationService.dll:PasswordAuthenticationService"
     UserAccountServiceModule = "OpenSim.Services.UserAccountService.dll:UserAccountService"
         
-; * This is the new style user service.
-; * "Realm" is the table that is used for user lookup.
-; * It defaults to "users", which uses the legacy tables
+; * This is the new style authentication service. Currently, only MySQL
+; * is implemented. "Realm" is the table that is used for user lookup.
+; * It defaults to "useraccounts", which uses the new style.
+; * Realm = "users" will use the legacy tables as an authentication source
 ; *
 [UserAccountService]
     ; for the server connector
     LocalServiceModule = "OpenSim.Services.UserAccountService.dll:UserAccountService"
     ; Realm = "useraccounts"
-    ;; These are for creating new accounts by the service
+
+    ; These are for creating new accounts by the service
     AuthenticationService = "OpenSim.Services.AuthenticationService.dll:PasswordAuthenticationService"
     PresenceService = "OpenSim.Services.PresenceService.dll:PresenceService"
     GridService = "OpenSim.Services.GridService.dll:GridService"
@@ -158,27 +163,21 @@ ServiceConnectors = "8003/OpenSim.Server.Handlers.dll:AssetServiceConnector,8003
 
     ; login page: optional: if it exists it will be used to tell the client to use
     ;                       this as splash page
-    ; currently unused
     ;welcome = http://127.0.0.1/welcome
 
     ; helper uri: optional: if it exists if will be used to tell the client to use
     ;                       this for all economy related things
-    ; currently unused
     ;economy = http://127.0.0.1:9000/
 
     ; web page of grid: optional: page providing further information about your grid
-    ; currently unused
     ;about = http://127.0.0.1/about/
 
     ; account creation: optional: page providing further information about obtaining
     ;                             a user account on your grid
-    ; currently unused
     ;register = http://127.0.0.1/register
 
     ; help: optional: page providing further assistance for users of your grid
-    ; currently unused
     ;help = http://127.0.0.1/help
 
     ; password help: optional: page providing password assistance for users of your grid
-    ; currently unused
     ;password = http://127.0.0.1/password