diff options
Diffstat (limited to 'bin/OpenSim.ini.example')
-rw-r--r-- | bin/OpenSim.ini.example | 142 |
1 files changed, 108 insertions, 34 deletions
diff --git a/bin/OpenSim.ini.example b/bin/OpenSim.ini.example index 9c68b65..6dbb611 100644 --- a/bin/OpenSim.ini.example +++ b/bin/OpenSim.ini.example | |||
@@ -1,19 +1,23 @@ | |||
1 | ;; This is the main configuration file for OpenSimulator. If it's named OpenSim.ini | 1 | ;; This is the main configuration file for OpenSimulator. |
2 | ;; then it will be loaded by OpenSimulator. If it's named OpenSim.ini.example then | 2 | ;; If it's named OpenSim.ini then it will be loaded by OpenSimulator. |
3 | ;; you will need to copy it to OpenSim.ini first (if that file does not already exist) | 3 | ;; If it's named OpenSim.ini.example then you will need to copy it to |
4 | ;; OpenSim.ini first (if that file does not already exist) | ||
4 | ;; | 5 | ;; |
5 | ;; If you are copying, then once you have copied OpenSim.ini.example to OpenSim.ini you will | 6 | ;; If you are copying, then once you have copied OpenSim.ini.example to |
6 | ;; need to pick an architecture in the [Architecture] section at the end of this file. | 7 | ;; OpenSim.ini you will need to pick an architecture in the [Architecture] |
8 | ;; section at the end of this file. | ||
7 | ;; | 9 | ;; |
8 | ;; The settings in this file are in the form "<key> = <value>". For example, save_crashes = false | 10 | ;; The settings in this file are in the form "<key> = <value>". For example, |
9 | ;; in the [Startup] section below. | 11 | ;; save_crashes = false in the [Startup] section below. |
10 | ;; | 12 | ;; |
11 | ;; All settings are initially commented out and the default value used, as found in | 13 | ;; All settings are initially commented out and the default value used, as |
12 | ;; OpenSimDefaults.ini. To change a setting, first uncomment it by deleting the initial semicolon (;) | 14 | ;; found in OpenSimDefaults.ini. To change a setting, first uncomment it by |
13 | ;; and then change the value. This will override the value in OpenSimDefaults.ini | 15 | ;; deleting the initial semicolon (;) and then change the value. This will |
16 | ;; override the value in OpenSimDefaults.ini | ||
14 | ;; | 17 | ;; |
15 | ;; If you want to find out what configuration OpenSimulator has finished with once all the configuration | 18 | ;; If you want to find out what configuration OpenSimulator has finished with |
16 | ;; files are loaded then type "config show" on the region console command line. | 19 | ;; once all the configuration files are loaded then type "config show" on the |
20 | ;; region console command line. | ||
17 | ;; | 21 | ;; |
18 | ;; | 22 | ;; |
19 | ;; NOTES FOR DEVELOPERS REGARDING THE FORMAT OF THIS FILE | 23 | ;; NOTES FOR DEVELOPERS REGARDING THE FORMAT OF THIS FILE |
@@ -26,13 +30,16 @@ | |||
26 | ;; formatted as: | 30 | ;; formatted as: |
27 | ;; {option} {depends on} {question to ask} {choices} default value | 31 | ;; {option} {depends on} {question to ask} {choices} default value |
28 | ;; Any text comments following the declaration, up to the next blank line. | 32 | ;; Any text comments following the declaration, up to the next blank line. |
29 | ;; will be copied to the generated file (NOTE: generation is not yet implemented) | 33 | ;; will be copied to the generated file (NOTE: generation is not yet |
34 | ;; implemented) | ||
35 | ;; | ||
30 | ;; A * in the choices list will allow an empty entry. | 36 | ;; A * in the choices list will allow an empty entry. |
31 | ;; An empty question will set the default if the dependencies are | 37 | ;; An empty question will set the default if the dependencies are |
32 | ;; satisfied. | 38 | ;; satisfied. |
33 | ;; | 39 | ;; |
34 | ;; ; denotes a commented out option. | 40 | ;; ; denotes a commented out option. |
35 | ;; Any options added to OpenSim.ini.example should be initially commented out. | 41 | ;; Any options added to OpenSim.ini.example should be initially commented |
42 | ;; out. | ||
36 | 43 | ||
37 | 44 | ||
38 | [Startup] | 45 | [Startup] |
@@ -47,9 +54,12 @@ | |||
47 | ;# {save_crashes} {} {Save crashes to disk?} {true false} false | 54 | ;# {save_crashes} {} {Save crashes to disk?} {true false} false |
48 | ;; Set this to true if you want to log crashes to disk | 55 | ;; Set this to true if you want to log crashes to disk |
49 | ;; this can be useful when submitting bug reports. | 56 | ;; this can be useful when submitting bug reports. |
50 | ;; However, this will only log crashes within OpenSimulator that cause the entire program to exit | 57 | ;; However, this will only log crashes within OpenSimulator that cause the |
51 | ;; It will not log crashes caused by virtual machine failures, which includes mono and ODE failures. | 58 | ;; entire program to exit |
52 | ;; You will need to capture these native stack traces by recording the session log itself. | 59 | ;; It will not log crashes caused by virtual machine failures, which |
60 | ;; includes mono and ODE failures. | ||
61 | ;; You will need to capture these native stack traces by recording the | ||
62 | ;; session log itself. | ||
53 | ; save_crashes = false | 63 | ; save_crashes = false |
54 | 64 | ||
55 | ;# {crash_dir} {save_crashes:true} {Directory to save crashes to?} {} crashes | 65 | ;# {crash_dir} {save_crashes:true} {Directory to save crashes to?} {} crashes |
@@ -87,23 +97,47 @@ | |||
87 | ;; from the selected region_info_source. | 97 | ;; from the selected region_info_source. |
88 | ; allow_regionless = false | 98 | ; allow_regionless = false |
89 | 99 | ||
100 | ;# {NonPhysicalPrimMin} {} {Minimum size of nonphysical prims?} {} 0.001 | ||
101 | ;; Minimum size for non-physical prims. Affects resizing of existing | ||
102 | ;; prims. This can be overriden in the region config file (as | ||
103 | ;; NonPhysicalPrimMin!). | ||
104 | ; NonPhysicalPrimMin = 0.001 | ||
105 | |||
90 | ;# {NonPhysicalPrimMax} {} {Maximum size of nonphysical prims?} {} 256 | 106 | ;# {NonPhysicalPrimMax} {} {Maximum size of nonphysical prims?} {} 256 |
91 | ;; Maximum size for non-physical prims. Affects resizing of existing prims. This can be overriden in the region config file (as NonphysicalPrimMax!). | 107 | ;; Maximum size for non-physical prims. Affects resizing of existing |
92 | ; NonphysicalPrimMax = 256 | 108 | ;; prims. This can be overriden in the region config file (as |
109 | ;; NonPhysicalPrimMax!). | ||
110 | ; NonPhysicalPrimMax = 256 | ||
111 | |||
112 | ;# {PhysicalPrimMin} {} {Minimum size of physical prims?} {} 10 | ||
113 | ;; Maximum size where a prim can be physical. Affects resizing of | ||
114 | ;; existing prims. This can be overriden in the region config file. | ||
115 | ; PhysicalPrimMin = 0.01 | ||
93 | 116 | ||
94 | ;# {PhysicalPrimMax} {} {Maximum size of physical prims?} {} 10 | 117 | ;# {PhysicalPrimMax} {} {Maximum size of physical prims?} {} 10 |
95 | ;; Maximum size where a prim can be physical. Affects resizing of existing prims. This can be overriden in the region config file. | 118 | ;; Maximum size where a prim can be physical. Affects resizing of |
119 | ;; existing prims. This can be overriden in the region config file. | ||
96 | ; PhysicalPrimMax = 10 | 120 | ; PhysicalPrimMax = 10 |
97 | 121 | ||
98 | ;# {ClampPrimSize} {} {Clamp viewer rezzed prims to max sizes?} {true false} false | 122 | ;# {ClampPrimSize} {} {Clamp viewer rezzed prims to max sizes?} {true false} false |
99 | ;; If a viewer attempts to rez a prim larger than the non-physical or physical prim max, clamp the dimensions to the appropriate maximum | 123 | ;; If a viewer attempts to rez a prim larger than the non-physical or |
124 | ;; physical prim max, clamp the dimensions to the appropriate maximum | ||
100 | ;; This can be overriden in the region config file. | 125 | ;; This can be overriden in the region config file. |
101 | ; ClampPrimSize = false | 126 | ; ClampPrimSize = false |
127 | |||
128 | ;# {LinksetPrims} {} {Max prims an object will hold?} {} 0 | ||
129 | ;; Maximum number of prims allowable in a linkset. Affects creating new | ||
130 | ;; linksets. Ignored if less than or equal to zero. | ||
131 | ;; This can be overriden in the region config file. | ||
132 | ; LinksetPrims = 0 | ||
102 | 133 | ||
103 | ;# {AllowScriptCrossing} {} {Allow scripts to cross into this region} {true false} true | 134 | ;# {AllowScriptCrossing} {} {Allow scripts to cross into this region} {true false} true |
104 | ;; Allow scripts to keep running when they cross region boundaries, rather than being restarted. State is reloaded on the destination region. | 135 | ;; Allow scripts to keep running when they cross region boundaries, rather |
105 | ;; This only applies when crossing to a region running in a different simulator. | 136 | ;; than being restarted. State is reloaded on the destination region. |
106 | ;; For crossings where the regions are on the same simulator the script is always kept running. | 137 | ;; This only applies when crossing to a region running in a different |
138 | ;; simulator. | ||
139 | ;; For crossings where the regions are on the same simulator the script is | ||
140 | ;; always kept running. | ||
107 | ; AllowScriptCrossing = true | 141 | ; AllowScriptCrossing = true |
108 | 142 | ||
109 | ;# {TrustBinaries} {AllowScriptCrossing:true} {Accept compiled binary script code? (DANGEROUS!)} {true false} false | 143 | ;# {TrustBinaries} {AllowScriptCrossing:true} {Accept compiled binary script code? (DANGEROUS!)} {true false} false |
@@ -173,7 +207,8 @@ | |||
173 | ;# {physics} {} {Select physics engine} {OpenDynamicsEngine BulletSim basicphysics POS} OpenDynamicsEngine | 207 | ;# {physics} {} {Select physics engine} {OpenDynamicsEngine BulletSim basicphysics POS} OpenDynamicsEngine |
174 | ;; OpenDynamicsEngine is by some distance the most developed physics engine | 208 | ;; OpenDynamicsEngine is by some distance the most developed physics engine |
175 | ;; BulletSim is incomplete and experimental but in active development | 209 | ;; BulletSim is incomplete and experimental but in active development |
176 | ;; basicphysics effectively does not model physics at all, making all objects phantom | 210 | ;; basicphysics effectively does not model physics at all, making all |
211 | ;; objects phantom | ||
177 | ;; Default is OpenDynamicsEngine | 212 | ;; Default is OpenDynamicsEngine |
178 | ; physics = OpenDynamicsEngine | 213 | ; physics = OpenDynamicsEngine |
179 | ; physics = BulletSim | 214 | ; physics = BulletSim |
@@ -216,8 +251,9 @@ | |||
216 | ;# {simple_build_permissions} {} {Allow building in parcel by access list (no groups)} {true false} false | 251 | ;# {simple_build_permissions} {} {Allow building in parcel by access list (no groups)} {true false} false |
217 | ;; More control over permissions | 252 | ;; More control over permissions |
218 | ;; This is definitely not SL! | 253 | ;; This is definitely not SL! |
219 | ;; Provides a simple control for land owners to give build rights to specific avatars | 254 | ;; Provides a simple control for land owners to give build rights to |
220 | ;; in publicly accessible parcels that disallow object creation in general. | 255 | ;; specific avatars in publicly accessible parcels that disallow object |
256 | ;; creation in general. | ||
221 | ;; Owners specific avatars by adding them to the Access List of the parcel | 257 | ;; Owners specific avatars by adding them to the Access List of the parcel |
222 | ;; without having to use the Groups feature | 258 | ;; without having to use the Groups feature |
223 | ; simple_build_permissions = false | 259 | ; simple_build_permissions = false |
@@ -253,11 +289,14 @@ | |||
253 | ; DrawPrimOnMapTile = true | 289 | ; DrawPrimOnMapTile = true |
254 | 290 | ||
255 | ;# {HttpProxy} {} {Proxy URL for llHTTPRequest and dynamic texture loading} {} http://proxy.com:8080 | 291 | ;# {HttpProxy} {} {Proxy URL for llHTTPRequest and dynamic texture loading} {} http://proxy.com:8080 |
256 | ;; Http proxy setting for llHTTPRequest and dynamic texture loading, if required | 292 | ;; Http proxy setting for llHTTPRequest and dynamic texture loading, if |
293 | ;; required | ||
257 | ; HttpProxy = "http://proxy.com:8080" | 294 | ; HttpProxy = "http://proxy.com:8080" |
258 | 295 | ||
259 | ;# {HttpProxyExceptions} {HttpProxy} {Set of regular expressions defining URL that should not be proxied} {} | 296 | ;# {HttpProxyExceptions} {HttpProxy} {Set of regular expressions defining URL that should not be proxied} {} |
260 | ;; If you're using HttpProxy, then you can set HttpProxyExceptions to a list of regular expressions for URLs that you don't want to go through the proxy | 297 | ;; If you're using HttpProxy, then you can set HttpProxyExceptions to a |
298 | ;; list of regular expressions for URLs that you don't want to go through | ||
299 | ;; the proxy. | ||
261 | ;; For example, servers inside your firewall. | 300 | ;; For example, servers inside your firewall. |
262 | ;; Separate patterns with a ';' | 301 | ;; Separate patterns with a ';' |
263 | ; HttpProxyExceptions = ".mydomain.com;localhost" | 302 | ; HttpProxyExceptions = ".mydomain.com;localhost" |
@@ -276,13 +315,15 @@ | |||
276 | ; SpawnPointRouting = closest | 315 | ; SpawnPointRouting = closest |
277 | 316 | ||
278 | ;# {TelehubAllowLandmark} {} {Allow users with landmarks to override telehub routing} {true false} false | 317 | ;# {TelehubAllowLandmark} {} {Allow users with landmarks to override telehub routing} {true false} false |
279 | ;; TelehubAllowLandmark allows users with landmarks to override telehub routing and land at the landmark coordinates when set to true | 318 | ;; TelehubAllowLandmark allows users with landmarks to override telehub |
319 | ;; routing and land at the landmark coordinates when set to true | ||
280 | ;; default is false | 320 | ;; default is false |
281 | ; TelehubAllowLandmark = false | 321 | ; TelehubAllowLandmark = false |
282 | 322 | ||
283 | ;# {AllowedClients} {} {Bar (|) separated list of allowed clients} {} | 323 | ;# {AllowedClients} {} {Bar (|) separated list of allowed clients} {} |
284 | ;; Bar (|) separated list of viewers which may gain access to the regions. | 324 | ;; Bar (|) separated list of viewers which may gain access to the regions. |
285 | ;; One can use a substring of the viewer name to enable only certain versions | 325 | ;; One can use a substring of the viewer name to enable only certain |
326 | ;; versions | ||
286 | ;; Example: Agent uses the viewer "Imprudence 1.3.2.0" | 327 | ;; Example: Agent uses the viewer "Imprudence 1.3.2.0" |
287 | ;; - "Imprudence" has access | 328 | ;; - "Imprudence" has access |
288 | ;; - "Imprudence 1.3" has access | 329 | ;; - "Imprudence 1.3" has access |
@@ -291,7 +332,8 @@ | |||
291 | 332 | ||
292 | ;# {BannedClients} {} {Bar (|) separated list of banned clients} {} | 333 | ;# {BannedClients} {} {Bar (|) separated list of banned clients} {} |
293 | ;# Bar (|) separated list of viewers which may not gain access to the regions. | 334 | ;# Bar (|) separated list of viewers which may not gain access to the regions. |
294 | ;; One can use a Substring of the viewer name to disable only certain versions | 335 | ;; One can use a Substring of the viewer name to disable only certain |
336 | ;; versions | ||
295 | ;; Example: Agent uses the viewer "Imprudence 1.3.2.0" | 337 | ;; Example: Agent uses the viewer "Imprudence 1.3.2.0" |
296 | ;; - "Imprudence" has no access | 338 | ;; - "Imprudence" has no access |
297 | ;; - "Imprudence 1.3" has no access | 339 | ;; - "Imprudence 1.3" has no access |
@@ -437,7 +479,8 @@ | |||
437 | [SimulatorFeatures] | 479 | [SimulatorFeatures] |
438 | 480 | ||
439 | ;# {MapImageServerURI} {} {URL for the map server} {} | 481 | ;# {MapImageServerURI} {} {URL for the map server} {} |
440 | ; Experimental new information sent in SimulatorFeatures cap for Kokua viewers | 482 | ; Experimental new information sent in SimulatorFeatures cap for Kokua |
483 | ; viewers | ||
441 | ; meant to override the MapImage and search server url given at login, and varying | 484 | ; meant to override the MapImage and search server url given at login, and varying |
442 | ; on a sim-basis. | 485 | ; on a sim-basis. |
443 | ; Viewers that don't understand it, will ignore it | 486 | ; Viewers that don't understand it, will ignore it |
@@ -675,7 +718,9 @@ | |||
675 | ;; Maximum number of events to queue for a script (excluding timers) | 718 | ;; Maximum number of events to queue for a script (excluding timers) |
676 | ; MaxScriptEventQueue = 300 | 719 | ; MaxScriptEventQueue = 300 |
677 | 720 | ||
678 | ;; Stack size per thread created | 721 | ;; Stack size per script engine thread in bytes. |
722 | ;; If you are experiencing StackOverflowExceptions you may want to increase this (e.g. double it). | ||
723 | ;; The trade-off may be increased memory usage by the script engine. | ||
679 | ; ThreadStackSize = 262144 | 724 | ; ThreadStackSize = 262144 |
680 | 725 | ||
681 | ;# {DeleteScriptsOnStartup} {} {Delete previously compiled script DLLs on startup?} (true false) true | 726 | ;# {DeleteScriptsOnStartup} {} {Delete previously compiled script DLLs on startup?} (true false) true |
@@ -902,6 +947,35 @@ | |||
902 | ;# {InitialTerrain} {} {Initial terrain type} {pinhead-island flat} pinhead-island | 947 | ;# {InitialTerrain} {} {Initial terrain type} {pinhead-island flat} pinhead-island |
903 | ; InitialTerrain = "pinhead-island" | 948 | ; InitialTerrain = "pinhead-island" |
904 | 949 | ||
950 | [TOSModule] | ||
951 | ;; Terms of Service module. It requires an external web script. Unless you | ||
952 | ;; have that in place, don't enable this module. | ||
953 | |||
954 | ;# {Enabled} {} {Enable TOS facilities} {true false} false | ||
955 | ; Enabled = false | ||
956 | |||
957 | ;; Should local users be shown the TOS on first login? | ||
958 | ;# {ShowToLocalUsers} {} {Show TOS to local users} {true false} false | ||
959 | ; ShowToLocalUsers = false | ||
960 | ;; Should foreign users be shown the TOS on first HG login? | ||
961 | ;# {ShowToForeignUsers} {} {Show TOS to foreign users} {true false} true | ||
962 | ; ShowToForeignUsers = true | ||
963 | |||
964 | ;; Tell the users what this is about | ||
965 | ; Message = "Please read and agree to the Terms of Service" | ||
966 | |||
967 | ;; How much time do the users have to accept the TOS before they get kicked out? | ||
968 | ;; (in minutes) | ||
969 | ; Timeout = 5 | ||
970 | |||
971 | ;; This page should have Accept/Decline links somewhere | ||
972 | ;; that affect the GridUsers table. If you don't have such | ||
973 | ;; script in place, don't use the TOSModule. The TOSModule appends this URL | ||
974 | ;; with a query ?user={userid}&sid={sessionid} | ||
975 | ;# {TOS_URL} {} {The URL for the TOS page} {} | ||
976 | TOS_URL = "http://mygrid.com/tos" | ||
977 | |||
978 | |||
905 | [Architecture] | 979 | [Architecture] |
906 | ;# {Include-Architecture} {} {Choose one of the following architectures} {config-include/Standalone.ini config-include/StandaloneHypergrid.ini config-include/Grid.ini config-include/GridHypergrid.ini config-include/SimianGrid.ini config-include/HyperSimianGrid.ini} config-include/Standalone.ini | 980 | ;# {Include-Architecture} {} {Choose one of the following architectures} {config-include/Standalone.ini config-include/StandaloneHypergrid.ini config-include/Grid.ini config-include/GridHypergrid.ini config-include/SimianGrid.ini config-include/HyperSimianGrid.ini} config-include/Standalone.ini |
907 | ;; Uncomment one of the following includes as required. For instance, to create a standalone OpenSim, | 981 | ;; Uncomment one of the following includes as required. For instance, to create a standalone OpenSim, |