aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/bin/OpenSim.ini.example
diff options
context:
space:
mode:
authorJustin Clark-Casey (justincc)2011-04-11 20:43:11 +0100
committerJustin Clark-Casey (justincc)2011-04-11 20:43:11 +0100
commite9c2beadecf8f531d2bbfcd3f44636cfeff08667 (patch)
treea16df73d0b6da13f4cb226181e1240b356d61234 /bin/OpenSim.ini.example
parentMerge branch 'queuetest' of ssh://opensimulator.org/var/git/opensim into queu... (diff)
downloadopensim-SC_OLD-e9c2beadecf8f531d2bbfcd3f44636cfeff08667.zip
opensim-SC_OLD-e9c2beadecf8f531d2bbfcd3f44636cfeff08667.tar.gz
opensim-SC_OLD-e9c2beadecf8f531d2bbfcd3f44636cfeff08667.tar.bz2
opensim-SC_OLD-e9c2beadecf8f531d2bbfcd3f44636cfeff08667.tar.xz
Add more instructions to OpenSim.ini.example to try and make it more understandable for new users.
Diffstat (limited to '')
-rw-r--r--bin/OpenSim.ini.example103
1 files changed, 68 insertions, 35 deletions
diff --git a/bin/OpenSim.ini.example b/bin/OpenSim.ini.example
index 5bac56e..390fe09 100644
--- a/bin/OpenSim.ini.example
+++ b/bin/OpenSim.ini.example
@@ -1,4 +1,22 @@
1;; A note on the format of this file 1;; This is the main configuration file for OpenSimulator. If it's named OpenSim.ini
2;; then it will be loaded by OpenSimulator. If it's named OpenSim.ini.example then
3;; you will need to copy it to OpenSim.ini first (if that file does not already exist)
4;;
5;; If you are copying, then once you have copied OpenSim.ini.example to OpenSim.ini you will
6;; need to pick an architecture in the [Architecture] section at the end of this file.
7;;
8;; The settings in this file are in the form "<key> = <value>". For example, save_crashes = false
9;; in the [Startup] section below.
10;;
11;; All settings are initially commented out and the default value used, as found in
12;; OpenSimDefaults.ini. To change a setting, first uncomment it by deleting the initial semicolon (;)
13;; and then change the value. This will override the value in OpenSimDefaults.ini
14;;
15;; If you want to find out what configuration OpenSimulator has used then type "config get" on the
16;; region console command line.
17;;
18;;
19;; NOTES FOR DEVELOPERS REGARDING FORMAT OF TIHS FILE
2;; 20;;
3;; All leading white space is ignored, but preserved. 21;; All leading white space is ignored, but preserved.
4;; 22;;
@@ -8,15 +26,14 @@
8;; formatted as: 26;; formatted as:
9;; {option} {depends on} {question to ask} {choices} default value 27;; {option} {depends on} {question to ask} {choices} default value
10;; Any text comments following the declaration, up to the next blank line. 28;; Any text comments following the declaration, up to the next blank line.
11;; will be copied to the generated file. 29;; will be copied to the generated file (NOTE: generation is not yet implemented)
12;; A * in the choices list will allow an empty entry.\ 30;; A * in the choices list will allow an empty entry.
13;; An empty question will set the default if the dependencies are 31;; An empty question will set the default if the dependencies are
14;; satisfied. 32;; satisfied.
15;; 33;;
16;; ; denotes a commented out option. Uncomment it to actvate it 34;; ; denotes a commented out option.
17;; and change it to the desired value 35;; Any options added to OpenSim.ini.example should be initially commented out.
18;; Any options added to OpenSim.ini.exmaple must be commented out, 36
19;; and their value must represent the default.
20 37
21[Startup] 38[Startup]
22 ;# {save_crashes} {} {Save crashes to disk?} {true false} false 39 ;# {save_crashes} {} {Save crashes to disk?} {true false} false
@@ -35,7 +52,7 @@
35 52
36 ;; Determine where OpenSimulator looks for the files which tell it 53 ;; Determine where OpenSimulator looks for the files which tell it
37 ;; which regions to server 54 ;; which regions to server
38 ;; Defaults to "filesystem" if this setting isn't present 55 ;; Default is "filesystem"
39 ; region_info_source = "filesystem" 56 ; region_info_source = "filesystem"
40 ; region_info_source = "web" 57 ; region_info_source = "web"
41 58
@@ -131,6 +148,7 @@
131 ;; ZeroMesher is faster but leaves the physics engine to model the mesh 148 ;; ZeroMesher is faster but leaves the physics engine to model the mesh
132 ;; using the basic shapes that it supports. 149 ;; using the basic shapes that it supports.
133 ;; Usually this is only a box. 150 ;; Usually this is only a box.
151 ;; Default is Meshmerizer
134 ; meshing = Meshmerizer 152 ; meshing = Meshmerizer
135 ; meshing = ZeroMesher 153 ; meshing = ZeroMesher
136 154
@@ -138,6 +156,7 @@
138 ;; OpenDynamicsEngine is by some distance the most developed physics engine 156 ;; OpenDynamicsEngine is by some distance the most developed physics engine
139 ;; basicphysics effectively does not model physics at all, making all 157 ;; basicphysics effectively does not model physics at all, making all
140 ;; objects phantom 158 ;; objects phantom
159 ;; Default is OpenDynamicsEngine
141 ; physics = OpenDynamicsEngine 160 ; physics = OpenDynamicsEngine
142 ; physics = basicphysics 161 ; physics = basicphysics
143 ; physics = POS 162 ; physics = POS
@@ -154,7 +173,6 @@
154 ;; permission checks (allowing anybody to copy 173 ;; permission checks (allowing anybody to copy
155 ;; any item, etc. This may not yet be implemented uniformally. 174 ;; any item, etc. This may not yet be implemented uniformally.
156 ;; If set to true, then all permissions checks are carried out 175 ;; If set to true, then all permissions checks are carried out
157 ;; Default is false
158 ; serverside_object_permissions = false 176 ; serverside_object_permissions = false
159 177
160 ;; This allows users with a UserLevel of 200 or more to assume god 178 ;; This allows users with a UserLevel of 200 or more to assume god
@@ -188,6 +206,7 @@
188 ;; server to send mail through. 206 ;; server to send mail through.
189 ; emailmodule = DefaultEmailModule 207 ; emailmodule = DefaultEmailModule
190 208
209
191[SMTP] 210[SMTP]
192 ;; The SMTP server enabled the email module to send email to external 211 ;; The SMTP server enabled the email module to send email to external
193 ;; destinations. 212 ;; destinations.
@@ -214,6 +233,7 @@
214 ;# {SMTP_SERVER_PASSWORD} {[Startup]emailmodule:DefaultEmailModule enabled:true} {SMTP server password} {} 233 ;# {SMTP_SERVER_PASSWORD} {[Startup]emailmodule:DefaultEmailModule enabled:true} {SMTP server password} {}
215 ; SMTP_SERVER_PASSWORD = "" 234 ; SMTP_SERVER_PASSWORD = ""
216 235
236
217[Network] 237[Network]
218 ;; Configure the remote console user here. This will not actually be used 238 ;; Configure the remote console user here. This will not actually be used
219 ;; unless you use -console=rest at startup. 239 ;; unless you use -console=rest at startup.
@@ -247,6 +267,7 @@
247 ;; " (Mozilla Compatible)" to the text where there are problems with a web server 267 ;; " (Mozilla Compatible)" to the text where there are problems with a web server
248 ; user_agent = "OpenSim LSL (Mozilla Compatible)" 268 ; user_agent = "OpenSim LSL (Mozilla Compatible)"
249 269
270
250[ClientStack.LindenUDP] 271[ClientStack.LindenUDP]
251 ;; See OpensSimDefaults.ini for the throttle options. You can copy the 272 ;; See OpensSimDefaults.ini for the throttle options. You can copy the
252 ;; relevant sections and override them here. 273 ;; relevant sections and override them here.
@@ -263,17 +284,18 @@
263 ;; building's lights to possibly not be rendered. 284 ;; building's lights to possibly not be rendered.
264 ; DisableFacelights = "false" 285 ; DisableFacelights = "false"
265 286
287
266[Chat] 288[Chat]
267 ;# {whisper_distance} {} {Distance at which a whisper is heard, in meters?} {} 10 289 ;# {whisper_distance} {} {Distance at which a whisper is heard, in meters?} {} 10
268 ;; Distance in meters that whispers should travel. Default is 10m 290 ;; Distance in meters that whispers should travel.
269 ; whisper_distance = 10 291 ; whisper_distance = 10
270 292
271 ;# {say_distance} {} {Distance at which normal chat is heard, in meters? (SL uses 20 here)} {} 30 293 ;# {say_distance} {} {Distance at which normal chat is heard, in meters? (SL uses 20 here)} {} 30
272 ;; Distance in meters that ordinary chat should travel. Default is 30m 294 ;; Distance in meters that ordinary chat should travel.
273 ; say_distance = 30 295 ; say_distance = 30
274 296
275 ;# {shout_distance} {Distance at which a shout is heard, in meters?} {} 100 297 ;# {shout_distance} {Distance at which a shout is heard, in meters?} {} 100
276 ;; Distance in meters that shouts should travel. Default is 100m 298 ;; Distance in meters that shouts should travel.
277 ; shout_distance = 100 299 ; shout_distance = 100
278 300
279 301
@@ -337,13 +359,13 @@
337 ;# {create_region_enable_voice} {enabled:true} {Enable voice for newly created regions?} {true false} false 359 ;# {create_region_enable_voice} {enabled:true} {Enable voice for newly created regions?} {true false} false
338 ;; set this variable to true if you want the create_region XmlRpc 360 ;; set this variable to true if you want the create_region XmlRpc
339 ;; call to unconditionally enable voice on all parcels for a newly 361 ;; call to unconditionally enable voice on all parcels for a newly
340 ;; created region [default: false] 362 ;; created region
341 ; create_region_enable_voice = false 363 ; create_region_enable_voice = false
342 364
343 ;# {create_region_public} {enabled:true} {Make newly created regions public?} {true false} false 365 ;# {create_region_public} {enabled:true} {Make newly created regions public?} {true false} false
344 ;; set this variable to false if you want the create_region XmlRpc 366 ;; set this variable to false if you want the create_region XmlRpc
345 ;; call to create all regions as private per default (can be 367 ;; call to create all regions as private per default (can be
346 ;; overridden in the XmlRpc call) [default: true] 368 ;; overridden in the XmlRpc call)
347 ; create_region_public = false 369 ; create_region_public = false
348 370
349 ;# {enabled_methods} {enabled:true} {List of methods to allow, separated by |} {} all 371 ;# {enabled_methods} {enabled:true} {List of methods to allow, separated by |} {} all
@@ -372,15 +394,16 @@
372 ;; default avatars 394 ;; default avatars
373 ; default_appearance = default_appearance.xml 395 ; default_appearance = default_appearance.xml
374 396
397
375[Wind] 398[Wind]
376 ;# {enabled} {} {Enable wind module?} {true false} true 399 ;# {enabled} {} {Enable wind module?} {true false} true
377 ;; Enables the wind module. Default is true 400 ;; Enables the wind module.
378 ;enabled = true 401 ; enabled = true
379 402
380 ;# {wind_update_rate} {enabled:true} {Wind update rate in frames?} {} 150 403 ;# {wind_update_rate} {enabled:true} {Wind update rate in frames?} {} 150
381 ;; How often should wind be updated, as a function of world frames. 404 ;; How often should wind be updated, as a function of world frames.
382 ;; Approximately 50 frames a second 405 ;; Approximately 50 frames a second
383 wind_update_rate = 150 406 ; wind_update_rate = 150
384 407
385 ;; The Default Wind Plugin to load 408 ;; The Default Wind Plugin to load
386 ; wind_plugin = SimpleRandomWind 409 ; wind_plugin = SimpleRandomWind
@@ -396,9 +419,10 @@
396 419
397 ;# {strength} {enabled:true wind_plugin:SimpleRandomWind} {Wind strength?} {} 1.0 420 ;# {strength} {enabled:true wind_plugin:SimpleRandomWind} {Wind strength?} {} 1.0
398 ;; This setting is specific to the SimpleRandomWind plugin 421 ;; This setting is specific to the SimpleRandomWind plugin
399 ;; Adjusts wind strength. 0.0 = no wind, 1.0 = normal wind. Default is 1.0 422 ;; Adjusts wind strength. 0.0 = no wind, 1.0 = normal wind.
400 ; strength = 1.0 423 ; strength = 1.0
401 424
425
402[LightShare] 426[LightShare]
403 ;# {enable_windlight} {} {Enable LightShare technology?} {true false} false 427 ;# {enable_windlight} {} {Enable LightShare technology?} {true false} false
404 ;; This enables the transmission of Windlight scenes to supporting clients, 428 ;; This enables the transmission of Windlight scenes to supporting clients,
@@ -406,7 +430,8 @@
406 ;; It has no ill effect on viewers which do not support server-side 430 ;; It has no ill effect on viewers which do not support server-side
407 ;; windlight settings. 431 ;; windlight settings.
408 ;; Currently we only have support for MySQL databases. 432 ;; Currently we only have support for MySQL databases.
409 ; enable_windlight = false; 433 ; enable_windlight = false
434
410 435
411[DataSnapshot] 436[DataSnapshot]
412 ;# {index_sims} {} {Enable data snapshotting (search)?} {true false} false 437 ;# {index_sims} {} {Enable data snapshotting (search)?} {true false} false
@@ -417,7 +442,6 @@
417 ;; and you can ignore the rest of these search-related configs. 442 ;; and you can ignore the rest of these search-related configs.
418 ; index_sims = false 443 ; index_sims = false
419 444
420
421 ;# {data_exposure} {index_sims:true} {How much data should be exposed?} {minimum all} minimum 445 ;# {data_exposure} {index_sims:true} {How much data should be exposed?} {minimum all} minimum
422 ;; The variable data_exposure controls what the regions expose: 446 ;; The variable data_exposure controls what the regions expose:
423 ;; minimum: exposes only things explicitly marked for search 447 ;; minimum: exposes only things explicitly marked for search
@@ -462,6 +486,7 @@
462 ;; Money Unit fee to create groups 486 ;; Money Unit fee to create groups
463 ; PriceGroupCreate = 0 487 ; PriceGroupCreate = 0
464 488
489
465[XEngine] 490[XEngine]
466 ;# {Enabled} {} {Enable the XEngine scripting engine?} {true false} true 491 ;# {Enabled} {} {Enable the XEngine scripting engine?} {true false} true
467 ;; Enable this engine in this OpenSim instance 492 ;; Enable this engine in this OpenSim instance
@@ -556,9 +581,9 @@
556 ;; Default is ./bin/ScriptEngines 581 ;; Default is ./bin/ScriptEngines
557 ; ScriptEnginesPath = "ScriptEngines" 582 ; ScriptEnginesPath = "ScriptEngines"
558 583
584
559[MRM] 585[MRM]
560 ;; Enables the Mini Region Modules Script Engine. 586 ;; Enables the Mini Region Modules Script Engine.
561 ;; default is false
562 ; Enabled = false 587 ; Enabled = false
563 588
564 ;; Runs MRM in a Security Sandbox 589 ;; Runs MRM in a Security Sandbox
@@ -580,6 +605,7 @@
580 ;; May represent a security risk if you disable this. 605 ;; May represent a security risk if you disable this.
581 ; OwnerOnly = true 606 ; OwnerOnly = true
582 607
608
583[FreeSwitchVoice] 609[FreeSwitchVoice]
584 ;; In order for this to work you need a functioning FreeSWITCH PBX set up. 610 ;; In order for this to work you need a functioning FreeSWITCH PBX set up.
585 ;; Configuration details at http://opensimulator.org/wiki/Freeswitch_Module 611 ;; Configuration details at http://opensimulator.org/wiki/Freeswitch_Module
@@ -593,6 +619,7 @@
593 ;; If using a remote module, specify the server URL 619 ;; If using a remote module, specify the server URL
594 ; FreeswitchServiceURL = http://my.grid.server:8003/fsapi 620 ; FreeswitchServiceURL = http://my.grid.server:8003/fsapi
595 621
622
596[FreeswitchService] 623[FreeswitchService]
597 ;; !!!!!!!!!!!!!!!!!!!!!!!!!!! 624 ;; !!!!!!!!!!!!!!!!!!!!!!!!!!!
598 ;; !!!!!!STANDALONE ONLY!!!!!! 625 ;; !!!!!!STANDALONE ONLY!!!!!!
@@ -611,6 +638,7 @@
611 ; UserName = "freeswitch" 638 ; UserName = "freeswitch"
612 ; Password = "password" 639 ; Password = "password"
613 640
641
614[Groups] 642[Groups]
615 ;# {Enabled} {} {Enable groups?} {true false} false 643 ;# {Enabled} {} {Enable groups?} {true false} false
616 ;; Enables the groups module 644 ;; Enables the groups module
@@ -634,7 +662,7 @@
634 ;# {ServicesConnectorModule} {Module:GroupsModule} {Service connector to use for groups} {XmlRpcGroupsServicesConnector SimianGroupsServicesConnector} XmlRpcGroupsServicesConnector 662 ;# {ServicesConnectorModule} {Module:GroupsModule} {Service connector to use for groups} {XmlRpcGroupsServicesConnector SimianGroupsServicesConnector} XmlRpcGroupsServicesConnector
635 ;; Service connectors to the Groups Service as used in the GroupsModule. Select one depending on 663 ;; Service connectors to the Groups Service as used in the GroupsModule. Select one depending on
636 ;; whether you're using a Flotsam XmlRpc backend or a SimianGrid backend 664 ;; whether you're using a Flotsam XmlRpc backend or a SimianGrid backend
637 ; ServicesConnectorModule = SimianGroupsServicesConnector 665 ; ServicesConnectorModule = XmlRpcGroupsServicesConnector
638 666
639 ;# {GroupsServerURI} {Module:GroupsModule} {Groups Server URI} {} 667 ;# {GroupsServerURI} {Module:GroupsModule} {Groups Server URI} {}
640 ;; URI for the groups services 668 ;; URI for the groups services
@@ -654,6 +682,7 @@
654 ; XmlRpcServiceReadKey = 1234 682 ; XmlRpcServiceReadKey = 1234
655 ; XmlRpcServiceWriteKey = 1234 683 ; XmlRpcServiceWriteKey = 1234
656 684
685
657[InterestManagement] 686[InterestManagement]
658 ;# {UpdatePrioritizationScheme} {} {Update prioritization scheme?} {BestAvatarResponsiveness Time Distance SimpleAngularDistance FrontBack} BestAvatarResponsiveness 687 ;# {UpdatePrioritizationScheme} {} {Update prioritization scheme?} {BestAvatarResponsiveness Time Distance SimpleAngularDistance FrontBack} BestAvatarResponsiveness
659 ;; This section controls how state updates are prioritized for each client 688 ;; This section controls how state updates are prioritized for each client
@@ -661,24 +690,28 @@
661 ;; SimpleAngularDistance, FrontBack 690 ;; SimpleAngularDistance, FrontBack
662 ; UpdatePrioritizationScheme = BestAvatarResponsiveness 691 ; UpdatePrioritizationScheme = BestAvatarResponsiveness
663 692
693
664[MediaOnAPrim] 694[MediaOnAPrim]
665 ;# {Enabled} {} {Enable Media-on-a-Prim (MOAP)} {true false} true 695 ;# {Enabled} {} {Enable Media-on-a-Prim (MOAP)} {true false} true
666 ;; Enable media on a prim facilities 696 ;; Enable media on a prim facilities
667 ; Enabled = true; 697 ; Enabled = true;
668 698
699
669[Architecture] 700[Architecture]
670 ;# {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 701 ;# {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
671 ;; Choose one of these architecture includes: 702 ;; Uncomment one of the following includes as required. For instance, to create a standalone OpenSim,
672 ;; Include-Architecture = "config-include/Standalone.ini" 703 ;; uncomment Include-Architecture = "config-include/Standalone.ini"
673 ;; Include-Architecture = "config-include/StandaloneHypergrid.ini" 704 ;;
674 ;; Include-Architecture = "config-include/Grid.ini" 705 ;; Then you will need to copy and edit the corresponding *Common.example file in config-include/
675 ;; Include-Architecture = "config-include/GridHypergrid.ini" 706 ;; that the referenced .ini file goes on to include.
676 ;; Include-Architecture = "config-include/SimianGrid.ini" 707 ;;
677 ;; Include-Architecture = "config-include/HyperSimianGrid.ini" 708 ;; For instance, if you chose "config-include/Standalone.ini" then you will need to copy
709 ;; "config-include/StandaloneCommon.ini.example" to "config-include/StandaloneCommon.ini" before
710 ;; editing it to set the database and backend services that OpenSim will use.
711 ;;
678 ; Include-Architecture = "config-include/Standalone.ini" 712 ; Include-Architecture = "config-include/Standalone.ini"
679 713 ; Include-Architecture = "config-include/StandaloneHypergrid.ini"
680 ;; Then choose 714 ; Include-Architecture = "config-include/Grid.ini"
681 ;; config-include/StandaloneCommon.ini.example (if you're in standlone) OR 715 ; Include-Architecture = "config-include/GridHypergrid.ini"
682 ;; config-include/GridCommon.ini.example (if you're connected to a grid) 716 ; Include-Architecture = "config-include/SimianGrid.ini"
683 ;; Copy to your own .ini there (without .example extension) and edit it 717 ; Include-Architecture = "config-include/HyperSimianGrid.ini"
684 ;; to customize your data