Configuration

OpenSim simulator configuration file
The region simulator configuration is managed using a file called OpenSim.ini. This file is used regardless of whether the sim is running in standalone or grid mode. This file references some additional configuration information from the config-include/ directory. Information about the various settings is contained in the OpenSim.ini file itself (or OpenSim.ini.example for reference).

Please note, that the name OpenSim.ini can be changed via command line arguments.

It is also possible to distribute the inifile settings over two files. This is useful if you want to run several OpenSim processes where most of your settings are identical except for a few. The master file is read first, then the inifile is read. Settings given in the inifile overrule settings given in the master file. The master file has the same format and the same keywords as the inifile, so the same documentation applies.

Database
Opensim's supports the following database-engines. Information about setting these up can be found in the OpenSim.ini.example file and the other various example files in bin/config-include.


 * SQLite (default - a lightweight database that comes bundled with OpenSim and can be used without requiring any extra configuration. It is mostly intended to get you up and running quickly, not for production use.  A few features here (such as attachment persistence) have not yet been fully implemented.
 * MySQL (fully supported). This is the recommended database for any use beyond experimentation or small standalone applications.
 * MSSQL (partially supported - some recent OpenSim features may not yet be implemented). See MSSQL-config for configuration information.

Standalone vs. Grid
We recommend that you first get OpenSim running in standalone mode before you attempt to connect it to a grid or run your own grid. OpenSim will start up in standalone mode out-of-the-box.

An OpenSim configuration consists of regions (run by region simulators) and backend data services (such as user, assets and inventory management).

A system running in standalone mode runs both the region simulator and all the data services in a single process when you run OpenSim.exe. In this mode you can run as many regions as you like but only on a single machine.



In grid mode, the data services are not part of the region server process. Instead, they are run in a separate executable called Robust.exe. A Robust shell can run all the services or they can be split amongst any number of Robust instances. This allows them to be run on entirely separate machines if necessary. In this mode, the OpenSim.exe acts solely as the region server, serving one or more regions that communicate with the separate data services. At this point you can run multiple OpenSim.exe region simulators on different machines.



Running in grid mode is more complicated than running in standalone mode. It requires an understanding of UUID, X,Y location, server handshake passwords, estates and estate owners, and a couple of other settings. These require more care and patience to set up. We strongly recommend that you don't attempt this unless you are extremely patient and very technically proficient.

= Running OpenSim in Standalone mode = If you download a binary distribution of OpenSim then running in standalone mode is relatively straightforward since it's configured this way by default. If you build OpenSim from the source distribution or from the git repository then you will need to


 * 1) Copy the bin/OpenSim.ini.example file to bin/OpenSim.ini
 * 2) Copy the bin/config-include/StandaloneCommon.ini.example file to bin/config-include/StandaloneCommon.ini

Running OpenSim is a matter of launching OpenSim.exe.

On a Windows command prompt, at OpenSim's bin directory execute OpenSim.exe Or if using the default ODE physics plugin under 64 bit Windows OpenSim.32BitLaunch.exe This is necessary because ODE cannot yet be compiled for 64 bit mode under Windows. If you're using Linux then run mono OpenSim.exe This can be done under both 32 and 64 bit modes with the ODE physics engine.

Running OpenSim for the first time
If you're running OpenSim for the first time then when you start it up it will ask you several questions at the console. These will set up a single region for you. The configuration will be placed at bin/Regions/Regions.ini which you can then go and edit later on.

Many of the questions have defaults. Here are some explanations of the questions asked.


 * New region name - the name for your region. Don't leave this blank!
 * Region UUID - the unique ID of your region. In pretty much all cases you will want to accept the randomly generated default in the square brackets.  The only time when you wouldn't is if you were trying to set up a configuration to point to pre-existing region data.  But in this case you are probably better off editing the Regions.ini file directly anyway
 * Region Location - this is the location of the region on the grid. In standalone mode you can safely leave these as the default (1000,1000).  If you were to set up additional regions later on in Regions.ini then they would need different grid co-ordinates (e.g. 1000,1001).  OpenSim regions can be placed anywhere on a 65536 by 65536 grid.
 * Internal IP address - This should always be 0.0.0.0 (0.0.0.0 means "listen for connections on any interface", basically a wildcard) if you want to access this server from the internet or another server on your internal network, this should be the IP address assigned to the OpenSim Server. You should also set up the server to Use a Static IP address, and not DHCP
 * Internal port - This is the IP port for all incoming client connections. The name is a bit misleading since it will be used externally (by a Second Life viewer, for instance) as well as internally. You can make this any port you want, but it is safe to leave at the default 9000. Each region on your server must have a unique port.
 * Allow alternate ports - This is currently experimental. Please leave it at the default of False.
 * External host name - If you leave this at the default 'SYSTEMIP' then this will become the LAN network address of the machine (e.g. 192.168.1.2). This is fine if you are connecting only from within your LAN.  If you want to connect to it from a client on the internet, this should be the External IP Address of your router.  Fully Qualified Domain Names (FQDNs) should also work.

The following details are also asked in OpenSim 0.6.9 and earlier.


 * Master Avatar UUID - This is a legacy OpenSim feature and can be left at the default of 00000000-0000-0000-0000-000000000000. Later on, you may want to change this to your own avatar's UUID in Regions.ini if you have problems editing terrain.
 * Master Avatar first name - This is an alternative way of specifying the master avatar by avatar name rather than UUID. If you press enter here then both this field and the last name field will be left blank.  Accepting the blank default is fine - this can always be changed later in Regions.ini
 * Master Avatar last name - The last name of the master avatar.
 * Master Avatar sandbox password - The password of the master avatar.

In OpenSim 0.7 and later, OpenSim asks you questions to set up an estate and an estate manager instead of a region master avatar. The questions are similar but you will not be asked for a UUID.

Don't forget the account details you use to set up the master avatar (in 0.6.9) or the estate manager (in 0.7 and later). Only this user will initially be able to configure the in-world settings for your region.

See Configuring_Regions for more information about the Regions.ini file that these questions generate.

If you want to create a user other than the estate manager, then type

create user

in the server console. This will ask you a series of questions for creating a user (such as first name, last name and password).

Connecting to OpenSim
To connect to your new sim with your user, start up a Second Life viewer with the following command line switches:

Client on same machine as OpenSim: -loginuri http://127.0.0.1:9000

Client on same LAN as OpenSim: -loginuri http://lan_ip:9000

Client on different machine or internet: -loginuri http://external_ip:9000

Then enter the user name and password you set up in the previous step and your new user should login.

Be aware of loopback problems when Running viewer &amp; server(s) on the same machine (LAN) by using the "external" configuration. ( You might notice endless waiting for region handshake .) See also troubleshoot hints. If you're having Connectivity problems. Be sure to read the Network Configuration Page. This is important if you see Region handshake issues

= Running OpenSim in Grid mode =

Running OpenSim in grid mode is considerably more complicated than running a standalone instance. Instead of running everything in the same process, backend data services (asset, inventory, etc.) are run in a process separate from OpenSim.exe. This allows multiple instances of OpenSim.exe to use the same asset and inventory data.

Step 1: Set up a ROBUST service instance
1. In the bin directory, copy Robust.ini.example to Robust.ini. Robust.ini.example is configured to run all the services in a single ROBUST instance.

2. Configure Robust.ini to use a MySQL database. Only MySQL is supported for running grid services. In Robust.ini find the [DatabaseService] section and change the ConnectionString so that it connects to your database.

3. Start up Robust.exe. If you don't see any errors (in red) on the console then you should be good to go.

Step 2: Configure an OpenSim.exe to use the ROBUST services
In standalone mode, both bin/OpenSim.ini and bin/config-include/StandaloneCommon.ini needed to be configured. The first file (OpenSim.ini) configures the region simulator itself. The second file (StandaloneCommon.ini) configures the data services. In standalone mode, all these are run in the same process on the same machine - hence it is common to use the same database for both region simulator data and the service data.

In grid mode, you still need to configure OpenSim.ini in order to control the region simulator (OpenSim.exe). Chiefly, you still need a database in order to store local simulator data (size and shape of objects on the region, information about items in objects, etc.).

However, since the services are now being run in a separate ROBUST instance, the region simulator has to be told to use connectors that communicate with remote services at known URLs.

The steps for both these operations are as follows.

1. Copy bin/OpenSim.ini.example to OpenSim.ini

2. Find the "storage_plugin" settings under the [Startup] section and enter your database connection details. As with standalone, you can run regions using local SQLite database or local MySQL databases.

3. Find the [Architecture] section in OpenSim.ini. Make sure that the "Include-Grid" setting is the only one that is active (all the others need to be commented out with a semi-colon).

4. Go to bin/config-include and copy GridCommon.ini.example to GridCommon.ini.

5. Open GridCommon.ini in a text editor. You will see lots of URL entries, each of which have dummy defaults of http://myassetserver.com:8003, http://myinventoryserver.com:8003, etc. You will need to change each of these to point towards the address of your ROBUST instance. For instance, if you're running ROBUST on a machine with a local IP address of 192.168.1.2, you will need to change AssetServerURI to the setting

AssetServerURI = "http://192.168.1.2:8003"

By default, the ROBUST services configured in Robust.ini will be listening on port 8003, so you don't need to change these numbers.

6. Run OpenSim.exe. If you're running OpenSim.exe for the first time you will get the same questions about setting up the region that occur on a first-run in standalone mode. Please see the standalone section for instructions on how to answer these.

If everything is set up correctly, when starting up OpenSim.exe you shouldn't see any errors. You should also see the ROBUST console display log lines saying that the region has registered with the grid service.

7. Login with a client. Your client startup line will look something like

-loginuri http://192.168.1.2:8002

The loginuri needs to be the address of the login service. In standalone mode, this was the same address as the region simulator. However, in grid mode this is the ROBUST hosted grid service login URL rather than the address of any of your simulators. In this case, 192.168.1.2 is the address of the ROBUST instance. The port of 8002 is the traditional one for the grid login service.

8. With any luck, you will now successful login. The login will generate log lines on both the ROBUST console and on the region simulator console that the client ends up logging into. If you have any difficulties, please see the notes in the standalone section. More OpenSim.exe instances can be added to your grid in exactly the same way as the first.

Legacy instructions for configuring the grid services in OpenSim 0.6.9
...

Some services are now run in a common 'ROBUST' (Basic Universal Server Technology) server shell while others are still run as separate legacy servers.

As of OpenSim 0.6.8, R.O.B.U.S.T. has connectors for the asset (A), grid (G) and inventory (I) functionality. The legacy servers are still required for user (U) and messaging (M) functionality. The steps below will get you up and running. We'll assume that your current directory is bin/ within the OpenSim distribution.

 Configure the user server  Start OpenSim.Grid.UserServer.exe You will be asked a number of configuration questions. If the grid servers are all on one machine, most defaults are safe to use. The configuration is stored in the UserServer_Config.xml file which can be changed afterwards if necessary. The user server will then load and display its prompt: User# 

Configure R.O.B.U.S.T.  Copy OpenSim.Server.ini.example to OpenSim.Server.ini. Don't forget to change ConnectionString for your database settings. (on version 0.6.6 copy OpenSim.Services.ini.example to OpenSim.Services.ini - then use OpenSim.Services instead OpenSim.Server)  Linux bin$ cp OpenSim.Server.ini.example OpenSim.Server.ini Windows C:\OpenSim\bin> copy OpenSim.Server.ini.example OpenSim.Server.ini Start OpenSim.Server.exe</li> The server will start up it's asset, inventory and grid components and display the R.O.B.U.S.T prompt:</li> R.O.B.U.S.T.# For more information on the R.O.B.U.S.T. configuration file and more information if you are migrating from an earlier release of OpenSim, refer to R.O.B.U.S.T.</li> </ul>

Configure the messaging server</li>  Start OpenSim.Grid.MessagingServer.exe</li> Answer the configuration questions. Again, if all servers are run on the same machine, it's safe to press enter for all questions. The configuration is stored in MessagingServer_Config.xml.</li> The server will start and present you with its prompt:</li> Messaging# </ul>

</ol>

For information on running the legacy servers, particularly if you're using an older version of before 0.6.7 that doesn't contain the ROBUST framework, see LegacyServers

Summary of commands for running grid service executables
 Windows  cd bin OpenSim.Grid.UserServer.exe OpenSim.Server.exe OpenSim.Grid.MessagingServer.exe

 Linux / Mac OS X  cd bin mono OpenSim.Grid.UserServer.exe mono OpenSim.Server.exe mono OpenSim.Grid.MessagingServer.exe

Configuring regions
When first run, a new OpenSim installation will ask you a series of questions to set up one region. If you want to change these settings or set up multiple regions, please see Configuring_Regions

Configuring and Starting the region simulator
<ol> Find the [Architecture] section, comment out the line that says</li> Include-Standalone   = "config-include/Standalone.ini" and uncomment the line saying Include-Grid        = "config-include/Grid.ini

save OpenSim.ini, and go into the config-include directory.</li> copy the following files</li> GridCommon.ini.example to GridCommon.ini CenomeCache.ini.example to CenomeCache.ini FlotsamCache.ini.example to FlotsamCache.ini

Open all these files (Grid.ini, GridCommon.ini, CenomeCache.ini and FlotsamCache.ini) and edit to suit your needs</li>

You should now be ready to start up your sim. The mode that OpenSim.exe starts in is normally controlled by a setting in your OpenSim.ini. It defaults to standalone mode if that setting is not specified or the file is not found. If you wish, you can force opensim to start in gridmode on the command line as follows:</li> OpenSim.exe -gridmode=true or if using the ODE physics plugin under 64 bit Windows OpenSim.32BitLaunch.exe or: mono OpenSim.exe -gridmode=true if you're using Mono under Linux or Mac OSX.

With any luck, everything will come up without fatal errors.

If you have problems using the OpenDynamicsEngine on *nix, try setting your stack reserve level higher than the default with the following command; <tt>ulimit -s 262144</tt> Or, run the opensim-ode.sh to start up OpenSimulator.

Go to the UserServer console, and type 'create user' to create a new avatar. It will prompt you for the name and password, and the X and Y of the sim that should be his home location. Use 1000 and 1000, or wherever you told your sim to live when you brought it up in standalone mode. At the console of any of these servers, you should be able to type 'help' to get a list of commands.</li>

You should now be able to connect to your new grid with your secondlife client. You need to tell your client to point at the UserServer rather than directly at the sim, though:</li> secondlife -loginuri http://127.0.0.1:8002/ 8002 is the default port for the UserServer, and that IP address should be changed to the server you are running the UserServer on, if they are not all on the same box. Happy OpenSimming! ''Note: if you are using Windows Vista, remember to start servers as Admin. If not it will prompt you an error in console like "Error - Access denied"'' </ol>

=Attaching your sim to someone else's grid= To set up the region server (i.e., <tt>OpenSim.exe</tt>) to connect to an external grid, you should edit the <tt>GridCommon.ini</tt> file in the <tt>bin/config-include</tt> directory. You will need to set the URIs to those given to you by the grid operator.

The other file you may have to change is in your <tt>bin/Regions</tt> directory. This is where your individual region config files are. If you only have one region, it will by default be called <tt>Regions.ini</tt> (in OpenSim 0.6.6 and earlier this was called <tt>regions.xml</tt>).

This can be edited with any text editor. The grid owner may tell you what X and Y location you can place your sim at (you can't have multiple sims at the same location on the grid). If so, the fields you will need to change in this file are <tt>sim_location_x</tt> and <tt>sim_location_y</tt>. And the <tt>external_host_name</tt> should be set to the hostname or IP address of your simulation server (i.e., the machine that is running <tt>OpenSim.exe</tt>). A list of public grids that you can attach your sim to is at OpenSim: Grids

=Further notes=

Running OpenSim 0.6.7 and onwards in 64 bit Windows
As of OpenSim 0.6.7, the default physics engine for OpenSim was changed to the ODE engine. This is because ODE is by far the most advanced physics engine plugin currently in OpenSim. Unfortunately, it has the drawback in that it's library is not compilable under 64bit in Windows. Therefore, 64 bit Windows users may need to run

OpenSim.32BitLaunch.exe

instead of

OpenSim.exe

To launch their region simulator.

An alternative is to use the basicphysics engine instead or one of the other alternative physics engines bundled with OpenSim, though all these are far less functional than the ODE plugin.

Note About Mono
If you're using mono, you should increase the value of the mono environment variable MONO_THREADS_PER_CPU from its default of 5 to some number that works for your sim. The exact number depends on many factors including: the number of CPUs in your machine, what else you use that machine for, how many regions you have in your sim, how many of them are adjacent, how many scripts you have, and how many avatars you expect to serve at the same time. As a reference, Wright Plaza in OSGrid, which is running as a single region on a sim and routinely hosts meetings with 20 avatars, uses the value 125.

If this number is too low, the operation of your sim will start to break in all sorts of different ways. A common symptom is the freezing of all activity upon login of a new avatar. Other symptoms are a lot more subtle.

For example: $ export MONO_THREADS_PER_CPU=125

Legacy Configuration Information
These are some pages containing some legacy configuration information of unknown accuracy.

OpenSim 0.6.6 legacy configuration information

OpenSim.exe command line options
OpenSim.exe has command line options which allow you to perform actions such as reading configuratio nfiles from a different directory. See OpenSim.exe Command Line Options for more details.

Script engine
OpenSim supports multiple script engines. See ScriptEngines for details. If you don't know what this means then the default script engine will be fine.

Permissions Configuration
OpenSim has a quite elaborate set of permissions. See OpenSim:Permissions(Server) for details. By default, permissions are not active on region simulators.

Logging
By default, OpenSim logs information to a file called OpenSim.log in the bin directory. See Logging for details on how to further configure this if required.

Configuration of region modules

 * IRCBridgeModule
 * Freeswitch_Module
 * Offline Messaging

Configuration of Metaverse Exchange Protocol (MXP)

 * Metaverse Exchange Protocol

Configuration of Web Server and Pages
OpenSim contains a web server that can serve up a variety of pages. Some which come from external files and some are generated internally.
 * External Files
 * Internally Generated

=References=


 * OpenOffice draw file for OpenSim standalone diagram
 * OpenOffice draw file for OpenSim grid diagram