Set configuration files to use key expansion for widely used common settings.

1 files changed, 87 insertions, 64 deletions

diff --git a/bin/Robust.HG.ini.example b/bin/Robust.HG.ini.example
index fe2b4f9..8982b71 100644
--- a/bin/Robust.HG.ini.example
+++ b/bin/Robust.HG.ini.example
@@ -10,6 +10,29 @@
 ; *            OpenSim.Server.Handlers.dll:XInventoryInConnector 
 ; * are started in port 8002, outside the firewall
 ; *
+; **
+; *
+; * The Const section allows us to define some basic information that we
+; * will use throughout our configuration. We will provide examples for 
+; * setting the base url of the Robust server and the public and private ports
+; * it uses. Changing the values of the constants will set the operating
+; * parameters thoughout the configuration. Other constants that may prove
+; * to be useful may be added to the followin section. They may be 
+; * referenced anywhere in the configuration by using ${Const|Name}. One
+; * such use is providing a base path for setting locations that Robust
+; * uses to write data.
+; * 
+[Const]
+
+    ; The URL of the Robust server
+    BaseURL = "http://127.0.0.1"
+    
+    ; The public port of the Robust server
+    PublicPort = "8002"
+
+    ; The private port of the Robust server
+    PrivatePort = "8003"
+
 ; * 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.
@@ -49,52 +72,52 @@
 
 
 [ServiceList]
-    AssetServiceConnector = "8003/OpenSim.Server.Handlers.dll:AssetServiceConnector"
-    InventoryInConnector = "8003/OpenSim.Server.Handlers.dll:XInventoryInConnector"
+    AssetServiceConnector = "${Const|PrivatePort}/OpenSim.Server.Handlers.dll:AssetServiceConnector"
+    InventoryInConnector = "${Const|PrivatePort}/OpenSim.Server.Handlers.dll:XInventoryInConnector"
     ;; Uncomment if you have set up Freeswitch (see [FreeswitchService] below)
     ;VoiceConnector = "8004/OpenSim.Server.Handlers.dll:FreeswitchServerConnector"
-    GridServiceConnector = "8003/OpenSim.Server.Handlers.dll:GridServiceConnector"
-    GridInfoServerInConnector = "8002/OpenSim.Server.Handlers.dll:GridInfoServerInConnector"
-    AuthenticationServiceConnector = "8003/OpenSim.Server.Handlers.dll:AuthenticationServiceConnector"
-    OpenIdServerConnector = "8002/OpenSim.Server.Handlers.dll:OpenIdServerConnector"
-    AvatarServiceConnector = "8003/OpenSim.Server.Handlers.dll:AvatarServiceConnector"
-    LLLoginServiceInConnector = "8002/OpenSim.Server.Handlers.dll:LLLoginServiceInConnector"
-    PresenceServiceConnector = "8003/OpenSim.Server.Handlers.dll:PresenceServiceConnector"
-    UserAccountServiceConnector = "8003/OpenSim.Server.Handlers.dll:UserAccountServiceConnector"
-    GridUserServiceConnector = "8003/OpenSim.Server.Handlers.dll:GridUserServiceConnector"
-    FriendsServiceConnector = "8003/OpenSim.Server.Handlers.dll:FriendsServiceConnector"
-    MapAddServiceConnector = "8003/OpenSim.Server.Handlers.dll:MapAddServiceConnector"
-    MapGetServiceConnector = "8002/OpenSim.Server.Handlers.dll:MapGetServiceConnector"
+    GridServiceConnector = "${Const|PrivatePort}/OpenSim.Server.Handlers.dll:GridServiceConnector"
+    GridInfoServerInConnector = "${Const|PublicPort}/OpenSim.Server.Handlers.dll:GridInfoServerInConnector"
+    AuthenticationServiceConnector = "${Const|PrivatePort}/OpenSim.Server.Handlers.dll:AuthenticationServiceConnector"
+    OpenIdServerConnector = "${Const|PublicPort}/OpenSim.Server.Handlers.dll:OpenIdServerConnector"
+    AvatarServiceConnector = "${Const|PrivatePort}/OpenSim.Server.Handlers.dll:AvatarServiceConnector"
+    LLLoginServiceInConnector = "${Const|PublicPort}/OpenSim.Server.Handlers.dll:LLLoginServiceInConnector"
+    PresenceServiceConnector = "${Const|PrivatePort}/OpenSim.Server.Handlers.dll:PresenceServiceConnector"
+    UserAccountServiceConnector = "${Const|PrivatePort}/OpenSim.Server.Handlers.dll:UserAccountServiceConnector"
+    GridUserServiceConnector = "${Const|PrivatePort}/OpenSim.Server.Handlers.dll:GridUserServiceConnector"
+    FriendsServiceConnector = "${Const|PrivatePort}/OpenSim.Server.Handlers.dll:FriendsServiceConnector"
+    MapAddServiceConnector = "${Const|PrivatePort}/OpenSim.Server.Handlers.dll:MapAddServiceConnector"
+    MapGetServiceConnector = "${Const|PublicPort}/OpenSim.Server.Handlers.dll:MapGetServiceConnector"
     ;; Uncomment this if you want offline IM to work
-    ; OfflineIMServiceConnector = "8003/OpenSim.Addons.OfflineIM.dll:OfflineIMServiceRobustConnector"
+    ; OfflineIMServiceConnector = "${Const|PrivatePort}/OpenSim.Addons.OfflineIM.dll:OfflineIMServiceRobustConnector"
     ;; Uncomment this if you want Groups V2 to work
-    ; GroupsServiceConnector = "8003/OpenSim.Addons.Groups.dll:GroupsServiceRobustConnector"
+    ; GroupsServiceConnector = "${Const|PrivatePort}/OpenSim.Addons.Groups.dll:GroupsServiceRobustConnector"
     ;; Uncomment to provide bakes caching
-    ;BakedTextureService = "8003/OpenSim.Server.Handlers.dll:XBakesConnector"
+    ;BakedTextureService = "${Const|PrivatePort}/OpenSim.Server.Handlers.dll:XBakesConnector"
 
     ;; Additions for Hypergrid
 
-    GatekeeperServiceInConnector = "8002/OpenSim.Server.Handlers.dll:GatekeeperServiceInConnector"
-    UserAgentServerConnector = "8002/OpenSim.Server.Handlers.dll:UserAgentServerConnector"
-    HeloServiceInConnector = "8002/OpenSim.Server.Handlers.dll:HeloServiceInConnector"
-    HGFriendsServerConnector = "8002/OpenSim.Server.Handlers.dll:HGFriendsServerConnector"
-    InstantMessageServerConnector = "8002/OpenSim.Server.Handlers.dll:InstantMessageServerConnector"
-    HGInventoryServiceConnector = "HGInventoryService@8002/OpenSim.Server.Handlers.dll:XInventoryInConnector"
-    HGAssetServiceConnector = "HGAssetService@8002/OpenSim.Server.Handlers.dll:AssetServiceConnector"
+    GatekeeperServiceInConnector = "${Const|PublicPort}/OpenSim.Server.Handlers.dll:GatekeeperServiceInConnector"
+    UserAgentServerConnector = "${Const|PublicPort}/OpenSim.Server.Handlers.dll:UserAgentServerConnector"
+    HeloServiceInConnector = "${Const|PublicPort}/OpenSim.Server.Handlers.dll:HeloServiceInConnector"
+    HGFriendsServerConnector = "${Const|PublicPort}/OpenSim.Server.Handlers.dll:HGFriendsServerConnector"
+    InstantMessageServerConnector = "${Const|PublicPort}/OpenSim.Server.Handlers.dll:InstantMessageServerConnector"
+    HGInventoryServiceConnector = "HGInventoryService@${Const|PublicPort}/OpenSim.Server.Handlers.dll:XInventoryInConnector"
+    HGAssetServiceConnector = "HGAssetService@${Const|PublicPort}/OpenSim.Server.Handlers.dll:AssetServiceConnector"
     ;; Uncomment this if you want Groups V2, HG to work
-    ; HGGroupsServiceConnector = "8002/OpenSim.Addons.Groups.dll:HGGroupsServiceRobustConnector"
+    ; HGGroupsServiceConnector = "${Const|PublicPort}/OpenSim.Addons.Groups.dll:HGGroupsServiceRobustConnector"
     ;; Additions for other add-on modules. For example:
-    ;; WifiServerConnector = "8002/Diva.Wifi.dll:WifiServerConnector"
+    ;; WifiServerConnector = "${Const|PublicPort}/Diva.Wifi.dll:WifiServerConnector"
 
     ;; Uncomment for UserProfiles see [UserProfilesService] to configure...
-    ; UserProfilesServiceConnector = "8002/OpenSim.Server.Handlers.dll:UserProfilesConnector"
+    ; UserProfilesServiceConnector = "${Const|PublicPort}/OpenSim.Server.Handlers.dll:UserProfilesConnector"
 
 
 ; * This is common for all services, it's the network setup for the entire
 ; * server instance, if none is specified above
 ; *
 [Network]
-    port = 8003
+    port = ${Const|PrivatePort}
 
     ; HTTPS for "Out of band" management applications such as the remote admin
     ; module. May specify https_main = True to make the main http server
@@ -116,7 +139,7 @@
     ; cert_pass = "password"
 
     ;; The follow 3 variables are for HTTP Basic Authentication for the Robust services.
-    ;; Use this if your central services in port 8003 need to be accessible on the Internet
+    ;; Use this if your central services in port ${Const|PrivatePort} need to be accessible on the Internet
     ;; but you want to protect them from unauthorized access.
     ; AuthType = "BasicHttpAuthentication"
     ; HttpAuthUsername = "some_username"
@@ -142,16 +165,16 @@
     ;# {HomeURI} {Hypergrid} {The Home URL of this world} {}
         ;; This is the address of the external robust server that
         ;; runs the UserAgentsService, possibly this server.
-        ;; For example http://myworld.com:8002
+        ;; For example http://myworld.com:${Const|PublicPort}
         ;; This is a default that can be overwritten in some sections.
-        ; HomeURI = "http://127.0.0.1:8002"
+        ; HomeURI = "${Const|BaseURL}:${Const|PublicPort}"
 
     ;# {GatekeeperURI} {Hypergrid} {The URL of the gatekeeper of this world} {}
         ;; This is the address of the external robust server
         ;; that runs the Gatekeeper service, possibly this server.
-        ;; For example http://myworld.com:8002
+        ;; For example http://myworld.com:${Const|PublicPort}
         ;; This is a default that can be overwritten in some sections.
-        ; GatekeeperURI = "http://127.0.0.1:8002"
+        ; GatekeeperURI = "${Const|BaseURL}:${Const|PublicPort}"
 
 
 [DatabaseService]
@@ -236,7 +259,7 @@
     ExportSupported = true
 
     ;; If you have this set under [Hypergrid], no need to set it here, leave it commented
-    ; GatekeeperURI = "http://127.0.0.1:8002"
+    ; GatekeeperURI = "http://127.0.0.1:${Const|PublicPort}"
 
 
 ; * This is the configuration for the freeswitch server in grid mode
@@ -390,31 +413,31 @@
     AllowRemoteSetLoginLevel = "false"
 
     ; For V2 map
-    MapTileURL = "http://127.0.0.1:8002/";
+    MapTileURL = "${Const|BaseURL}:${Const|PublicPort}/";
 
     ; Url to search service
-    ; SearchURL = "http://127.0.0.1:8002/";
+    ; SearchURL = "${Const|BaseURL}:${Const|PublicPort}/";
 
     ; For V3 destination guide
-    ; DestinationGuide = "http://127.0.0.1/guide"
+    ; DestinationGuide = "${Const|BaseURL}/guide"
 
     ; For V3 avatar picker (( work in progress ))
-    ; AvatarPicker = "http://127.0.0.1/avatars"
+    ; AvatarPicker = "${Const|BaseURL}/avatars"
 
     ; If you run this login server behind a proxy, set this to true
     ; HasProxy = false
     
     ; Defaults for the users, if none is specified in the useraccounts table entry (ServiceURLs)
     ;; If you have GatekeeperURI set under [Hypergrid], no need to set it here, leave it commented
-    ; GatekeeperURI = "http://127.0.0.1:8002"
+    ; GatekeeperURI = "${Const|BaseURL}:${Const|PublicPort}"
 
-    SRV_HomeURI = "http://127.0.0.1:8002"
-    SRV_InventoryServerURI = "http://127.0.0.1:8002"
-    SRV_AssetServerURI = "http://127.0.0.1:8002"
-    SRV_ProfileServerURI = "http://127.0.0.1:8002"
-    SRV_FriendsServerURI = "http://127.0.0.1:8002"
-    SRV_IMServerURI = "http://127.0.0.1:8002"
-    SRV_GroupsServerURI = "http://127.0.0.1:8002"
+    SRV_HomeURI = "${Const|BaseURL}:${Const|PublicPort}"
+    SRV_InventoryServerURI = "${Const|BaseURL}:${Const|PublicPort}"
+    SRV_AssetServerURI = "${Const|BaseURL}:${Const|PublicPort}"
+    SRV_ProfileServerURI = "${Const|BaseURL}:${Const|PublicPort}"
+    SRV_FriendsServerURI = "${Const|BaseURL}:${Const|PublicPort}"
+    SRV_IMServerURI = "${Const|BaseURL}:${Const|PublicPort}"
+    SRV_GroupsServerURI = "${Const|BaseURL}:${Const|PublicPort}"
 
     ;; Regular expressions for controlling which client versions are accepted/denied.
     ;; An empty string means nothing is checked.
@@ -452,7 +475,7 @@
     ; Set this if you want to change the default
     ; TilesStoragePath = "maptiles"
     ;
-    ; If for some reason you have the AddMapTile service outside the firewall (e.g. 8002),
+    ; If for some reason you have the AddMapTile service outside the firewall (e.g. ${Const|PublicPort}),
     ; you may want to set this. Otherwise, don't set it, because it's already protected.
     ; GridService = "OpenSim.Services.GridService.dll:GridService"
     ;
@@ -470,7 +493,7 @@
     ; See http://opensimulator.org/wiki/GridInfo
 
     ; login uri: for grid this is the login server URI
-    login = http://127.0.0.1:8002/
+    login = ${Const|BaseURL}:${Const|PublicPort}/
 
     ; long grid name: the long name of your grid
     gridname = "the lost continent of hippo"
@@ -480,32 +503,32 @@
 
     ; login page: optional: if it exists it will be used to tell the client to use
     ;                       this as splash page
-    ;welcome = http://127.0.0.1/welcome
+    ;welcome = ${Const|BaseURL}/welcome
 
     ; helper uri: optional: if it exists if will be used to tell the client to use
     ;                       this for all economy related things
-    ;economy = http://127.0.0.1:8002/
+    ;economy = ${Const|BaseURL}:${Const|PublicPort}/
 
     ; web page of grid: optional: page providing further information about your grid
-    ;about = http://127.0.0.1/about/
+    ;about = ${Const|BaseURL}/about/
 
     ; account creation: optional: page providing further information about obtaining
     ;                             a user account on your grid
-    ;register = http://127.0.0.1/register
+    ;register = ${Const|BaseURL}/register
 
     ; help: optional: page providing further assistance for users of your grid
-    ;help = http://127.0.0.1/help
+    ;help = ${Const|BaseURL}/help
 
     ; password help: optional: page providing password assistance for users of your grid
-    ;password = http://127.0.0.1/password
+    ;password = ${Const|BaseURL}/password
         
     ; HG address of the gatekeeper, if you have one
     ; this is the entry point for all the regions of the world
-    ; gatekeeper = http://127.0.0.1:8002/
+    ; gatekeeper = ${Const|BaseURL}:${Const|PublicPort}/
 
     ; HG user domain, if you have one
     ; this is the entry point for all user-related HG services
-    ; uas = http://127.0.0.1:8002/
+    ; uas = ${Const|BaseURL}:${Const|PublicPort}/
 
 
 [GatekeeperService]
@@ -520,7 +543,7 @@
     SimulationService ="OpenSim.Services.Connectors.dll:SimulationServiceConnector"
     ; how does the outside world reach me? This acts as public key too.
         ;; If you have GatekeeperURI set under [Hypergrid], no need to set it here, leave it commented
-    ; ExternalName = "http://127.0.0.1:8002"
+    ; ExternalName = "${Const|BaseURL}:${Const|PublicPort}"
 
     ; 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
@@ -551,11 +574,11 @@
     ;;
     ;; If ForeignAgentsAllowed is true, make exceptions using AllowExcept.
     ;; Leave blank or commented for no exceptions.
-    ; AllowExcept = "http://griefer.com:8002, http://enemy.com:8002"
+    ; AllowExcept = "http://griefer.com:${Const|PublicPort}, http://enemy.com:8002"
     ;;
     ;; If ForeignAgentsAllowed is false, make exceptions using DisallowExcept
     ;; Leave blank or commented for no exceptions.
-    ; DisallowExcept = "http://myfriendgrid.com:8002, http://myboss.com:8002"
+    ; DisallowExcept = "http://myfriendgrid.com:${Const|PublicPort}, http://myboss.com:8002"
 
 
 [UserAgentService]
@@ -589,11 +612,11 @@
     ;;
     ;; If ForeignTripsAllowed is false, make exceptions using DisallowExcept
     ;; Leave blank or commented for no exceptions.
-    ; DisallowExcept_Level_0 = "http://myothergrid.com:8002, http://boss.com:8002"
+    ; DisallowExcept_Level_0 = "http://myothergrid.com:${Const|PublicPort}, http://boss.com:8002"
         ;;
     ;; If ForeignTripsAllowed is true, make exceptions using AllowExcept.
     ;; Leave blank or commented for no exceptions.
-    ; AllowExcept_Level_200 = "http://griefer.com:8002, http://enemy.com:8002"
+    ; AllowExcept_Level_200 = "http://griefer.com:${Const|PublicPort}, http://enemy.com:8002"
 
         ;; This variable controls what is exposed to profiles of local users
         ;; as seen from outside of this grid. Leave it uncommented for exposing
@@ -621,7 +644,7 @@
     AvatarService = "OpenSim.Services.AvatarService.dll:AvatarService"
 
     ;; Can overwrite the default in [Hypergrid], but probably shouldn't
-    ; HomeURI = "http://127.0.0.1:8002"
+    ; HomeURI = "${Const|BaseURL}:${Const|PublicPort}"
 
 
 ; * The interface that local users get when they are in other grids.
@@ -633,7 +656,7 @@
     UserAccountsService = "OpenSim.Services.UserAccountService.dll:UserAccountService"
 
     ;; Can overwrite the default in [Hypergrid], but probably shouldn't
-    ; HomeURI = "http://127.0.0.1:8002"
+    ; HomeURI = "${Const|BaseURL}:${Const|PublicPort}"
 
     ;; The asset types that this grid can export to / import from other grids.
     ;; Comma separated.
@@ -678,7 +701,7 @@
 
     ;; What is the HomeURI of users associated with this grid?
     ;; Can overwrite the default in [Hypergrid], but probably shouldn't
-    ; HomeURI = "http://127.0.0.1:8002"
+    ; HomeURI = "${Const|BaseURL}:${Const|PublicPort}"
 
 
 [UserProfilesService]