Changes to .ini.example files to improve instructions and workflow for standalone setups

Clarify what must be changed in initial .ini files to create a working
standalone setup now that [Const] variables are used. Fix separator used
in one of choice lists for [Const] BaseURL descriptor. Minor changes to
line spacing of some sections in StandaloneCommon.ini.example file for
layout regularity. Correction of a typo in comment.

Signed-off-by: Diva Canto <diva@metaverseink.com>

2 files changed, 18 insertions, 20 deletions

diff --git a/bin/OpenSim.ini.example b/bin/OpenSim.ini.example
index 138e498..2e7eb65 100644
--- a/bin/OpenSim.ini.example
+++ b/bin/OpenSim.ini.example
@@ -3,9 +3,12 @@
 ;; If it's named OpenSim.ini.example then you will need to copy it to 
 ;; OpenSim.ini first (if that file does not already exist)
 ;;
-;; If you are copying, then once you have copied OpenSim.ini.example to 
-;; OpenSim.ini you will need to pick an architecture in the [Architecture] 
-;; section at the end of this file.
+;; Once you have copied OpenSim.ini.example to OpenSim.ini you will at least
+;; need to set the constants in the [Const] section and pick an architecture
+;; in the [Architecture] section at the end of this file. The architecture
+;; will require a suitable .ini file in the config-include directory, either
+;; Standalone.ini or GridCommon.ini which you can copy and modify from the
+;; available .example files.
 ;;
 ;; The settings in this file are in the form "<key> = <value>".  For example, 
 ;; save_crashes = false in the [Startup] section below.
@@ -46,12 +49,13 @@
     ; For a grid these will usually be the externally accessible IP/DNS
     ; name and use default public port 8002 and default private port 8003
     ; For a standalone this will usually be the externally accessible IP/DNS
-    ; name and use a single common port 9000
+    ; name and use default public port 9000. The private port is not used
+    ; in the configuration for a standalone.
 
-    ;# {BaseURL} {} {BaseURL} {"http://example.com","http://127.0.0.1"} "http://127.0.0.1"
+    ;# {BaseURL} {} {BaseURL} {"http://example.com" "http://127.0.0.1"} "http://127.0.0.1"
     BaseURL = http://127.0.0.1
     
-    ;# {PublicPort} {} {PublicPort} {8002} "8002"
+    ;# {PublicPort} {} {PublicPort} {8002 9000} "8002"
     PublicPort = "8002"
 
     ;# {PrivatePort} {} {PrivatePort} {8003} "8003"
@@ -1068,7 +1072,7 @@
 
     ;# {MessagingModule} {MessagingEnabled:true} {Module to use for groups messaging} {GroupsMessagingModule "Groups Messaging Module V2"} GroupsMessagingModule
     ; MessagingModule = GroupsMessagingModule
-    ;; or use V2 for Groups V2
+    ; or use "Groups Messaging Module V2" for Groups V2
     ; MessagingModule = "Groups Messaging Module V2"
 
     ;# {NoticesEnabled} {Module:GroupsModule Module:Groups Module V2} {Enable group notices?} {true false} true
@@ -1131,7 +1135,7 @@
 
 ;;
 ;; Optional module to highlight God names in the viewer.
-;; Uncomment and costumize appropriately if you want this behavior.
+;; Uncomment and customize appropriately if you want this behavior.
 ;;
 ;[GodNames]
 ;       Enabled = false
diff --git a/bin/config-include/StandaloneCommon.ini.example b/bin/config-include/StandaloneCommon.ini.example
index 1063040..09c902c 100644
--- a/bin/config-include/StandaloneCommon.ini.example
+++ b/bin/config-include/StandaloneCommon.ini.example
@@ -54,12 +54,12 @@
     ; GatekeeperURI = "${Const|BaseURL}:${Const|PublicPort}"
 
 [Modules]
-    ;; Choose one cache module and the corresponding config file, if it exists.
+    ;; Optionally choose one cache module and the corresponding config file, if it exists.
     ;; Copy the config .example file into your own .ini file and alter that
     ;; We recommend the use of the FlotsamAssetCache since this is most actively maintained.
 
-    AssetCaching = "FlotsamAssetCache"
-    Include-FlotsamCache = "config-include/FlotsamCache.ini"
+    ;AssetCaching = "FlotsamAssetCache"
+    ;Include-FlotsamCache = "config-include/FlotsamCache.ini"
 
     ;AssetCaching = "CenomeMemoryAssetCache"
     ;Include-CenomeCache = "config-include/CenomeCache.ini"
@@ -73,7 +73,6 @@
     DefaultAssetLoader = "OpenSim.Framework.AssetLoader.Filesystem.dll"
     AssetLoaderArgs = "assets/AssetSets.xml"
 
-
 [GridService]
     ;; For in-memory region storage (default)
     StorageProvider = "OpenSim.Data.Null.dll:NullRegionData"
@@ -84,7 +83,7 @@
     ; MapTileDirectory = "./maptiles"
 
     ;; Next, we can specify properties of regions, including default and fallback regions
-    ;; The syntax is: Region_<RegioName> = "<flags>"
+    ;; The syntax is: Region_<RegionName> = "<flags>"
     ;; where <flags> can be DefaultRegion, FallbackRegion, NoDirectLogin, Persistent, LockedOut
     ;;  
     ;; 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.)
@@ -350,7 +349,6 @@
     ;; to block this info from being exposed.
     ; ShowUserDetailsInHGProfile = True
 
-
 [HGInventoryService]
     ;; If you have this set under [Hypergrid], no need to set it here, leave it commented
     ; HomeURI = "${Const|BaseURL}:${Const|PublicPort}"
@@ -371,7 +369,6 @@
     ; DisallowExport ="LSLText"
     ; DisallowImport ="LSLBytecode"
 
-
 [HGInventoryAccessModule]
     ;; If you have these set under [Hypergrid], no need to set it here, leave it commented
     ; HomeURI = "${Const|BaseURL}:${Const|PublicPort}"
@@ -395,7 +392,6 @@
     ;; If you have this set under [Hypergrid], no need to set it here, leave it commented
     ; GatekeeperURI = "${Const|BaseURL}:${Const|PublicPort}"
 
-
 [EntityTransfer]
     ;; User level from which local users are allowed to HG teleport. Default 0 (all users)
     ;LevelHGTeleport = 0
@@ -408,12 +404,10 @@
     ;; Comma-separated list of account names
     AccountForAppearance = "Test User, Astronaut Smith"
 
-;; UserProfiles Service
-;;
-;; To use, set Enabled to true then configure for your site...
 [UserProfilesService]
-    LocalServiceModule = "OpenSim.Services.UserProfilesService.dll:UserProfilesService"
+    ;; To use, set Enabled to true then configure for your site...
     Enabled = false
+    LocalServiceModule = "OpenSim.Services.UserProfilesService.dll:UserProfilesService"
 
     ;; Configure this for separate databse
     ; ConnectionString = "Data Source=localhost;Database=opensim;User ID=opensim;Password=***;Old Guids=true;"