OpenSimulator - User contributions [en]

Network Settings

2009-10-14T19:05:06Z

Taftr:

{{Template:Quicklinks}}
 

OpenSim/Grid can be pretty tricky when it comes to setting it up on a private network this document covers what OpenSim needs in terms of network resources.

==Ports used by OpenSim==

===Grid===

* TCP/8000 - Reserved
* TCP/8001 - Grid Server - Regions and other grid services talk to this
* TCP/8002 - User Server and Login Services - Clients, Regions, and other grid services talk to this
* TCP/8003 - Asset Services - Regions and other grid services talk to this
* TCP/8004 - Inventory Services - Regions and other grid services talk to this
* TCP/8005 - Reserved (Dispatch Services)
* TCP/8006 - Messaging Server

''* TCP/8895 - no longer needed for region to region communications''

==These ports must be open on any box running a simulator that attaches to a grid:==

* UDP+TCP/9000 - Default First Simulator - grid, regions, and clients talk to these
* UDP+TCP/9001 - Default Second Simulator - grid, regions, and clients talk to these
* UDP+TCP/900x - Each next simulator...

''* TCP/8895 - no longer needed for region to region communications''
===StandAlone===
* UDP+TCP/9000 - Everything runs on this port

===Initial setup===
* Check your /bin/Regions/default.xml
It shows something like this:
<source lang =xml>
<Config sim_UUID="1e988108-76ec-45db-b89e-4ba98905681c" sim_name="mysimname" sim_location_x="1000" sim_location_y="1000"
internal_ip_address="192.168.2.101" internal_ip_port="9000" allow_alternate_ports="false"
external_host_name="82.73.39.77" master_avatar_uuid="00000000-0000-0000-0000-000000000000"
estate_covanant_uuid="00000000-0000-0000-0000-000000000000"
master_avatar_first="test" master_avatar_last="user" master_avatar_pass="******" />
</source>
* Retrieve your [http://www.ip-adress.com/ external_host_name]
* Get your internal_ip_address (ipconfig for windows, or ifconfig for linux)
* Make sure the settings match

If you have a router in front of your internet-modem, check out ''NAT and Port Forwarding''.
Else you're good to go.

==NAT and Port Forwarding ==
=== Straightforward ===

If your host does not have a public IP address (eg it is hidden behind a home router) you will have issues hosting grid and region servers if you plan on connecting clients to it on both sides of the router, however this can be worked around through the use of port forwarding and ip-redirecting.This will also correct issues where the client hangs at region handshake. 

*Set internal_ip_address to your local LAN-ip(e.g. 192.168.2.1) (region xml-file)
*Set the external_host_name to your external IP-Address (Not a hostname, since DNS-resolving doesn't work properly) (region xml-file)
*Forward the appropriate ports to the OpenSim-server on both UDP and TCP (router-setup)
*Open appropriate ports on the OpenSim-server's firewall on both UDP and TCP 
*Reroute traffic for '''Linux:'''
**iptables -t nat -A OUTPUT --dst '''''EXTERNAL_IP''''' -p tcp --dport 9000:9010 -j DNAT --to-destination '''INTERNAL_IP'''
**iptables -t nat -A OUTPUT --dst '''''EXTERNAL_IP''''' -p udp --dport 9000:9010 -j DNAT --to-destination '''''INTERNAL_IP'''''
**service iptables restart 

Those iptables lines will redirect any traffic going to '''''EXTERNAL_IP''''' on ports 9000 to 9010 to I'''''NTERNAL_IP'''''. The internal ip is the LAN-IP of your server, and External ip is your internet IP. ''Use the above iptables command on all internal machines'' except your gateway/router. This assumes your gateway/router machine does not also host your sim. This also assume you have a default ACCEPT policy on your internal machines. So to connect from within your LAN, use the above iptables commands to reroute the traffic to the server internal ip.

*Reroute traffic for '''Windows:'''
**netsh (this method needs experimentation and elaboration. Please see the [[Talk:Network Settings|Discussion page]] for some guesswork on where to start)
***note from paulieFlomar: I tried using Windows built-in tools like FireWall, netsh, and IP Security Policy. My experience with these tools was unsuccessful. I then tried to create an outgoing rule with some third-party firewall products. I tried ZoneAlarm and Sunbelt Firewall. Neither of these products would allow me to create outgoing rules. Finally, I tried creating an outgoing rule in my Linux IP Tables firewall. This worked. I created 2 rules which I placed in a firewall script, before my NAT rule. The rules were:

iptables -t nat -A PREROUTING --dst '''''EXTERNAL_IP''''' -p tcp --dport 9000:9010 -j DNAT --to-destination '''''INTERNAL_IP'''''

iptables -t nat -A PREROUTING --dst '''''EXTERNAL_IP''''' -p udp --dport 9000:9010 -j DNAT --to-destination '''''INTERNAL_IP'''''

These rules worked. I can now access my region from my LAN.

Optional:

*Register an external domain-name (for external connections)
*Use Bind for internal domain-name resolving

===DynDNS loopback===

This method was used and successfully tested using www.dyndns.com (creates a virtual domain for your pc/ip, like yourcomputer.ath.cx) as loopback for devices on a LAN with three machines (pentium 2.8ghz running windows xp - internet server , amd opteron running ubuntu 7.10 64bit - as opensim server - and MacBook with OSX 10.4.11 - as client), a modem (thomson/alcatel speedtouch 330) and a mini-switch (which brand no one ever heard of). The connection of these machines is made as following: Modem -> Win Pc -> Switch -> Mac and Ubuntu. Dyndns is used to loopback to the Win Pc, and then it forwards the request to the internal LAN opensim server, which grants everything for the client. As for the client, if he is inside the private LAN then he is now actually someone on the internet requesting for access to the opensim server. Thus, if the client is someone on the internet then he will be treated like that. Tricky ? Further details ahead:

Method:
* Set the simulator listening IP address to your dyndns domain - edit ''opensim/bin/Regions/default.xml''; and change the external_host_name to ''external_host_name="yourcomputer.ath.cx"''. Leave internal_ip_address "0.0.0.0" and port "9000".
* Set the client (SecondLife Viewer) -loginuri to "yourcomputer.ath.cx:8002" (the port used was 8002, yours can be different if you configured it that way) - i didnt used the -loginserver flag also.
* Port Forward the above ports on the internet server (in this case, win xp). You do so by creating exceptions in Windows Firewall for the above mentioned ports, and for both connections: Internet Connection and LAN - this keeps the ports open for the web requests to travel over the private network.
* Edit "hosts" file (on windows, this is C:\Windows\System32\Drivers\etc\hosts and on Unix-type systems, this is /etc/hosts) entry on your internet server (in this case, win xp box) and add the following line: ''xxx.xxx.xxx.xxx<nowiki>    </nowiki> yourcomputer.ath.cx''. Of course, xxx.xxx.xxx.xxx is your opensim server internal LAN IP.

yourcomputer.ath.cx is now available for everyone to connect and you may login with the client!

===DynDNS and the free IPCop Linux Firewall===

Here an other way with the IPCop Linux Firewall, DynDNS and a OpenSimulator server

* Setup an IPCop firewall with 3 interfaces (red, green, orange) and put the OpenSimulator server on the orange interface (all OpenSimulator server's on one Linux box). Red is the internet, green is your lan.
* Setup the DynDNS service on the IPCop Firewall.
* change the external_host_name in the default.xml to the DynDNS name
* do'nt change the internal_ip_address in the default.XML, it should be 0.0.0.0
* if there, delete all loopbacks in /etc/hosts only 127.0.0.1 should be localhost
* customize the Port Forwarding on the IPCop Firewall (8002 TCP, 9000 UDP/TCP and for every additonal region 900X UDP/TCP). Port forwarding should be set to the (orange) interface adress of the OpenSimulator Box

Then it should be possible to conenct from inside the LAN (green) and it is also possible to conenct from the internet (over the red interface).
(well, the inside-lan connections are also made now over the RED interface, but infact, this is in the same ISP network, it should be quit fast ;-)
* Attention : the ports on the IPCop Firewall must also be open if you connect from inside (green) to your OpenSimulator Grid !

If you are using the OS WebGui, do'nt forget to set the "SMTP AUTH" in your email server. Most of the dynamic IPs are blocked at ISP level so the new users do'nt get any confirmation email.

This was tested with the Hippo OpenSim Viewer and with the Login URL : http://DynDNSName:8002

===Local connections with ZyXEL DSL modem/router and NAT/Port Forwarding===

This solution works with the ZyXEL Prestige 660ME-61 DSL Router. It may work with other models made by ZyXEL.

Method:
* Connect by TELNET to your ZyXEL DSL modem. Use the same IP address that you would if you were using the web interface. For example, the default ip on most Embarq ZyXEL DSL modems is 192.168.2.1.

telnet 192.168.2.1

* Enter your password. If you do not know it, try just pressing <ENTER> or ask your ISP for the password. They may or may not give it to you.

* Select menu option "24. System Maintenance" from the menu.

Copyright (c) 1994 - 2004 ZyXEL Communications Corp.
Prestige 660ME-61 Main Menu
Getting Started Advanced Management
1. General Setup 21. Filter Set Configuration
2. WAN Backup Setup 22. SNMP Configuration
3. LAN Setup 23. System Password
4. Internet Access Setup 24. System Maintenance
25. IP Routing Policy Setup
Advanced Applications 26. Schedule Setup
11. Remote Node Setup
12. Static Routing Setup
15. NAT Setup 99. Exit
Enter Menu Selection Number:

* Select menu option "8. Command Interpreter Mode" from the menu

Menu 24 - System Maintenance
1. System Status
2. System Information and Console Port Speed
3. Log and Trace
4. Diagnostic
5. Backup Configuration
6. Restore Configuration
7. Upload Firmware
8. Command Interpreter Mode
9. Call Control
10. Time and Date Setting
11. Remote Management
Enter Menu Selection Number:

* At the prompt type "ip nat loopback on".

Copyright (c) 1994 - 2004 ZyXEL Communications Corp.
Sprint > ip nat loopback on

* At the prompt type "exit".

Sprint> exit

* Select menu option "99. Exit"

* Follow all other steps for configuring and starting your server as outlined in [http://opensimulator.org/wiki/Main_Page#Getting_Started_with_OpenSim Getting Started].

===Local connections with the DLink GamerLounge Extreme N router===
Networking and router configurations have been responsible for 98% of all trouble I have had setting up and operating OpenSimulator region server software. Insuring that you have a capable router properly configured should be the first thing on the list of configuration checkpoints for a smooth and trouble-free path to OpenSimulator software operations in GridMode.

Below is a series of screen snapshots with the key pages of my router configuration interface with proper settings displayed.

The settings below assume that you have an otherwise working connection and do not touch on such subjects as port conflicts or logging your network onto your ISP's provider network.

{|
|[[image:router config snapshot1.png|250px|thumb|'''1.Status''']]
|[[image:router config snapshot2.png|250px|thumb|'''2.Advanced > Gaming''']]
|[[image:router config snapshot3.png|250px|thumb|'''3.Routing''']]
|}
{|
|[[image:router config snapshot4.png|250px|thumb|'''4.firewall''']]
|[[image:router config snapshot5.png|250px|thumb|'''5.Advanced network settings''']]
|}

* provided that all information supplied in ~opensim/bin/OpenSim.ini and in your ~opensim/Regions/*.xml are properly configured, this should have you up and running.

===Local and Internet connections with Linux iptables and NAT/Port Forwarding===

Please don't copy this verbatim - much more should go into a firewall setup, but this will at a bare minimum get NAT working with forwarding to your OpenSim server from both inside and outside your LAN.

Example firewall.sh script:
<source lang =bash>
echo 1 > /proc/sys/net/ipv4/ip_forward
echo 1 > /proc/sys/net/netfilter/nf_conntrack_tcp_be_liberal
echo 0 > /proc/sys/net/ipv4/conf/all/accept_redirects
echo 0 > /proc/sys/net/ipv4/conf/all/accept_source_route
echo 0 > /proc/sys/net/ipv4/conf/all/send_redirects
echo 1 > /proc/sys/net/ipv4/conf/all/log_martians
echo 1 > /proc/sys/net/ipv4/conf/all/rp_filter
modprobe nf_conntrack_ftp
modprobe nf_nat_ftp

INT = "eth0" # your internal network card on the firewall
EXT = "eth1" # Your external network card on the firewall
IPTABLES = "/sbin/iptables" # Path to your iptables executable

OPENSIMEXT = "66.102.1.103/32" # Example external IP - replace with yours
OPENSIMINT = "192.168.1.240/32" # Internal IP of your OpenSim server
INTSUBNET = "192.168.1.0/24" # Your internal subnet range

# Flush rules when we are restarting the script
$IPTABLES -F
$IPTABLES -F -t nat
$IPTABLES -F -t mangle

# Set up sane defaults
$IPTABLES -P INPUT DROP
$IPTABLES -P OUTPUT ACCEPT
$IPTABLES -P FORWARD DROP

# Allow all connections from inside the network to the firewall on all ports
$IPTABLES -A INPUT -i $INT -j ACCEPT
# Allow all outbound connections from the inside. Much better to limit this...
$IPTABLES -A FORWARD -o $EXT -j ACCEPT

# Configure basic NAT
$IPTABLES -A FORWARD -i $EXT -m state --state RELATED,ESTABLISHED -j ACCEPT
$IPTABLES -t nat -A POSTROUTING -o $EXT -j SNAT --to-source $OUTNAT

# Configure forwarding for OpenSim (you need to add ports if you are not running in standalone
# or if you are running more than one region)
$IPTABLES -A PREROUTING -p tcp -d $OPENSIMEXT --dport 9000 -j DNAT --to-destination $OPENSIMINT
$IPTABLES -A PREROUTING -p udp -d $OPENSIMEXT --dport 9000 -j DNAT --to-destination $OPENSIMINT

# Now for the magical juice that lets inside users and outside users both access your server
# Configure to allow internal network users to access the OpenSim server using the
# external IP address. This fixes failing to connect to regions over UDP due to NAT config
# Make sure you configure the proper external IP for each of your regions
$IPTABLES -t nat -A PREROUTING -i $INT -s $INTSUBNET -d $OPENSIMEXT -j DNAT --to-destination $OPENSIMINT
$IPTABLES -t nat -A POSTROUTING -o $INT -s $INTSUBNET -d $OPENSIMINT -j DNAT --to-source $OPENSIMEXT

</source>

NOTE: Contrary to what is displayed above, DHCP services are not required to operate OpenSimulator server software.
[[Category:Users]]

Configuration

2009-10-14T18:57:08Z

Taftr:

__NOTOC__
{{Template:Quicklinks}}
 
== OpenSim Command line options ==
To run OpenSim in somewhat customized environments it's often helpful to modify the programs behaviour via command line arguments.
OpenSim knows a just a few of these as most parts of the behaviour are controlled via an .INI-File (see below).

The following command line switches are known:
{| border="1"
! Switch !! Meaning/Behaviour
|-
| background ||
|-
| gridmode || If =true forces OpenSim.exe to operate in grid mode. If =false forces OpenSim.exe to operate in standalone mode. If omitted defaults to OpenSim.ini setting.
|-
| gui || "old-style" console
|-
| inidirectory ||
|-
| inifile || changes the name (Path) of the inifile. See below for details
|-
| inimaster || allows to read in a master config file. See below for details
|-
| physics ||
|}

==OpenSim configuration file==
The 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. Detailed information on the options available for setttings in this file can be found [[OpenSim.ini|here]].
Please note, that the name OpenSim.ini can be changed via command line arguments (see above). Also, note that the default download does not include an OpenSim.ini file, but rather provides an example file. To get started editing your ini file, please cd into opensim/bin/ and copy OpenSim.ini.example to OpenSim.ini.

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 but some settings differ.
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.

==Standard config in Windows==
===0.6.6 Release Information===
This release had some bugs with default automatic configuration on the first startup of OpenSim.exe. bin/Regions/default.xml (region configuration file) is not automatically created in the main directory. Therefore, you must manually create this file. Here is an example.
<pre>
<Root>
<Config sim_UUID="UUID" sim_name="NAME" sim_location_x="1000" sim_location_y="1000"
internal_ip_address="IP_ADDRESS_OF_SERVER" internal_ip_port="9000" allow_alternate_ports="false"
external_host_name="DNS_NAME_OF_SERVER" master_avatar_uuid="00000000-0000-0000-0000-000000000000"
estate_covanant_uuid="00000000-0000-0000-0000-000000000000" master_avatar_first="FIRST_NAME"
master_avatar_last="SECOND_NAME" master_avatar_pass="PASSWORD" />
</Root>
</pre>
You must change UUID, NAME, IP_ADDRESS_OF_SERVER, DNS_NAME_OF_SERVER, FIRST_NAME, SECOND_NAME and PASSWORD to your own values.
(I noticed than IP_ADDRESS_OF_SERVER should be set to real IP not to 127.0.0.1)

'''Summary''':

*Run OpenSim0.6.6Setup.exe and install OpenSim in Windows
*Run OpenSim.exe and enter default values - record them!
*Shutdown simulator (command: shutdown)
*Create default.xml with copy of above
*Change values in default.xml with recoded values
*Be sure default.xml be in main directory (same with OpenSim.ini)
*Run again OpenSim.exe
*Connect with viewer

===Running OpenSim in 64 bit Windows on the future 0.6.7 release===
[[Image:Exclamation.png|left]]
In Git revision 077d01, the default physics engine for OpenSim was changed to the ODE engine. This is because ODE is by far the most advanced physics engine. Unfortunately, it has the drawback in that it's library is not compilable under 64bit. 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 ODE.

== Logging ==
Usually you don't have a debugger and the source code at hand when a situation comes up. OpenSim does some logging to give you information about how it works.
This is done by use of the [http://logging.apache.org/log4net/index.html log4net-package]. The obvious console output of OpenSim as well as the OpenSim.log output are done via this package and come readily configured out of the box. But you can also make extended use of all other options this package can give you.

OpenSim makes use of the .NET System.Configuration API which means that the file that holds all the logging configuration is bin/OpenSim.exe.config .

More information on how to configure log4net can be found on the [http://logging.apache.org/log4net/release/manual/configuration.html log4net web pages].

==Database==
Opensim's supports the following database-engines:
* 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.)
* MySQL (fully supported)
* MSSQL (partially supported - some recent OpenSim features may not yet be implemented)
* Postgresql (fully supported - Still in Beta phase but working)

More information on database support can be found on the [[OpenSim Database support]] page.

==Script engine==
OpenSim supports multiple script engines. See [[ScriptEngines]] for details

==Permissions Configuration==
OpenSim has a quite elaborate set of permissions. See [[OpenSim:Permissions(Server)]] for details.

==Standalone vs. Grid==
We recommend that you first get OpenSim running in standalone mode before you attempt to connect it to a grid, either your own grid or a public grid. An OpenSim configuration consists of regions (run by region simulators) and 5 core backend services (which manage users, the grid, assets, inventories, and grid-wide messaging, collectively known as UGAIM).

A system running in '''standalone mode''' (that is, one with OpenSim.ini configured such that gridmode = false) -- also known as "sandbox mode" -- runs everything (all UGAIM services and one or more regions) in a single executable (OpenSim.exe). External regions cannot be added to an OpenSim running in this mode.

In '''grid mode''', the five services ([[User Server|User]], [[Grid Server|Grid]], [[Asset Server|Asset]], [[Inventory Server|Inventory]], [[Messaging Server|Messaging]], or UGAIM) are not part of the region server. This means that they can be run either on the same machine or spread out across multiple computers. In this mode, OpenSim.exe serves one or more regions, which communicate with the core servers. This mode even allows region servers run by other people on their own machines to connect, if you wish.

Naturally, this means that running in grid mode is somewhat 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 are not difficult, but do require a little more care in setting things up.

If you want to run a grid of your own (either private or public) you would start the core services up before connecting a region simulator. If you want to connect your region server to a grid that someone else is running, you need only start the region server in grid mode (with the necessary security keys and location information mentioned in the last paragraph).

OpenSim.exe responds to various command line arguments. These include "-inifile", "-configfile", "-gridmode", "-physics", "-config" & "-noverbose". When starting OpenSim in either Windows or Linux, one could, for example, add "-physics=OpenDynamicsEngine" to run the OpenDynamicsEngine instead of basicphysics, or use "-gridmode=true" to force opensim.exe to run as a region server (the rest of the grid services have their own executables). As many of these settings are normally controlled by OpenSim.ini, most users (especially in standalone mode) will not add any command line arguments.

=== Standalone mode ===

When you start OpenSim in standalone mode, it will ask you several questions at the console. The first set of prompts that start with "NETWORK SERVERS INFO", you can just hit return to accept the defaults if you will be running in standalone mode. The prompts that start with "DEFAULT REGION CONFIG" are where you need to start paying attention. Some are self-explanatory. Here are explanations for the others: 

*Grid Location. OpenSim regions can be placed anywhere on a 65536 by 65536 grid. In standalone mode, it is safe to leave these X and Y locations at their defaults for the first region (additional regions will need different coordinates, of course).
*Filename for local storage. Safe to leave at default.
*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 IP port for incoming UDP client connection. 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 
*External host name. If you will only be attaching to your sim from a SecondLife client on the same machine, you can leave this at the default 127.0.0.1. If you will be wanting to connect to it from a client on another machine or the internet, this should be the External IP Address of your router, not the Domain Name. (Hmm - Tried hostname (the one resolved by dns) and it worked out oke.)
*Be aware of [http://osgrid.org/forums/viewtopic.php?f=5&t=400&start=0&st=0&sk=t&sd=a loopback] problems when Running viewer & server(s) on the same machine (LAN) by using the "external" configuration. ('''You might notice endless waiting for region handshake'''.) See also [http://opensimulator.org/wiki/Troubleshooting troubleshoot hints]
*If your having Connectivity problems. [http://opensimulator.org/wiki/Network_Settings Be sure to read the Network Configuration Page]. This is important if you see Region handshake issues.

To connect to your new sim, start up secondlife with the following command line switches:

'''Client on same machine as OpenSim:''' -loginuri http://127.0.0.1:9000/ -loginpage http://127.0.0.1:9000/?method=login

Client on different machine or internet:''' -loginuri http://external_ip:9000/ -loginpage http://external_ip:9000/?method=login'''

To create a user:

type create user <first> <last> <password> <x_loc> <y_loc> in the server console. 

===Grid mode===
You want to run your own grid. Great! Assuming that you already got your sim running in standalone mode, here is what you need to do: 
1. Current builds of OpenSim grid mode are using mysql to store the grid information. You must have this installed and configured if you want to run your own grid. See [[mysql-config]] for more information. 

[[Image:Exclamation.png|left]]
NOTE: The grid servers are in the process of being redesigned. Therefore, there is a "legacy" way
and a new way of starting things. The most up to date information can be found in the configuration
file examples in your OpenSim kit.

The new system consists of services and connectors that are run in a server shell (Basic Universal
Server Technology, R.O.B.U.S.T.)

For information on running the legacy servers, see [[LegacyServers]]

===Starting the grid services===
Currently, R.O.B.U.S.T has connectors for the asset and inventory functionality. Therefore, some of the legacy servers are still required to run. Following the steps below will get you up and running in no time!

* 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, just press enter for all questions except fot the defult inventory server. The default inventory server needs to be given as http://127.0.0.1:8003, because R.O.B.U.S.T uses only one port.
::The user server will then load and display it's prompt:
User#
* Configure the grid server
::Start OpenSim.Grid.GridServer.exe
::Again, you will be asked a few questions and it's safe to accept the defaults if all servers are run on one machine. You will then see the grid server prompt:
Grid#
* Configure R.O.B.U.S.T.
::Copy OpenSim.Server.ini.example to OpenSim.Server.ini
::(on version 0.6.6 copy OpenSim.Services.ini.example to OpenSim.Services.ini - then use OpenSim.Services instead OpenSim.Server)
::Don't forget change ConnectionString accordingly your database settings.
Linux
bin$ cp OpenSim.Server.ini.example OpenSim.Server.ini
Windows
C:\OpenSim\bin> copy OpenSim.Server.ini.example OpenSim.Server.ini
For more information on the R.O.B.U.S.T. configuration file, refer to [[R.O.B.U.S.T.]]

::Start OpenSim.Server.exe
The server will start up it's asset and inventory components and display the R.O.B.U.S.T prompt:
R.O.B.U.S.T.#
* Configure the message server
::Start OpenSim.Grid.MessagingServer.exe
::Answer the configuration questions. Again, if all servers are run on the same machine, it's safe to press enter for all questions
::The server will start and present you with it's prompt:
Messaging#

===Starting the regions===
When using R.O.B.U.S.T., a setting that was not needed in standalone mode needs to be changed from it's default.
Open OpenSim.ini and find the section titled [Network]. Change the inventory_server_url to read http://127.0.0.1:8003.
[Network]
inventory_server_url = "http://127.0.0.1:8003"

Next, find the [Architecture] section, comment out the line that says
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.
copy the following files
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

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:
OpenSim.exe -gridmode=true
or:
mono OpenSim.exe -gridmode=true
With any luck, everything will come up without too many errors. 

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.

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:
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"''

==Multiple regions==
Using Physical Prim with the OpenDynamicsEngine on *nix, it's recommended that you set your stack reserve level higher then default with the following command;
<tt>ulimit -s 262144</tt> Or, run the opensim-ode.sh to start up OpenSimulator.

A powerful region generator is available at: [[RegionGenerator]]

For running multiple regions on the same box, you simply make multiple copies of the 'default.xml' file inside the <tt>bin/Regions/</tt> directory. You can do this by typing <tt>create region</tt> at the OpenSim command prompt, using the script <tt>make.php</tt> in <tt>share/regions</tt>, or you can generate the files by hand.

If you want to create the files by hand:

:first copy the default.xml file in the <tt>bin/Regions</tt> directory, and name them anything you want (I name mine region.x.y.xml, where region is the name of the region, and x and y are the grid coords.)
:Open each xml file and edit the uuid (a generator can be found at [http://www.famkruithof.net/uuid/uuidgen uuidgen webpage] or on unix, use the uuidgen command), region name, x & y positions, and internal IP port.

'''IMPORTANT!''' Regardless of the method you use to create your new region, the UUID, name, and grid coordinates ''must'' be unique for each region on a grid. The port assignment must be unique for each region that is running on a particular machine. The internal IP ''address'' and external host name must be the same for all regions.

Note that <tt>sim_location_x</tt> and <tt>sim_location_y</tt> should be adjacent integers if you want your regions to be adjacent, so you can run back and forth between them. '''IMPORTANT: THESE GRID COORDINATES ARE ''NOT'' IN METERS. THEY ARE SIM POSITIONS.''' (1000, 1000) is next to (1001,1000), (1000, 1001), and so forth. 1256, 2000, 2048 and similar values are '''not''' adjacent to 1000, they are very far away, so you would not see your sims from one another.

Once you have 2 or more xml files in the bin/Regions folder, running a ''single'' copy of <tt>OpenSim.exe</tt> will start up all of your sims! If you come across any errors, there is most likely an error in your xml files.

As of 6-Feb-2008, take care NOT to leave editor backup copies of the files in this directory e.g. emacs style backup names like Regionname.xml~. These are loaded by opensim.exe as if they are legitimate region descriptions, and will therefore give errors indicating you are trying to re-use the socket for that region.

==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>OpenSim.ini</tt> file in the <tt>bin</tt> directory. In that file, there is a <tt>[Network]</tt> section with URLs for the grid, user, and asset servers, as well as send and receive keys (for a basic level of security). The addresses and send/receive keys will vary depending on the grid you are connecting to, and the grid operator should tell you what values to use.

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>default.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]]

==Running==

===StandAlone===
'''Windows'''
cd bin
OpenSim.exe
On Windows Vista, it may be necessary to explicitly "Run as administrator" for opensim.exe to accept connections from a client, even when running as an administrator user. Navigate to the opensim\bin directory, right click opensim.exe, and select "Run as administrator".
Connect: opensim://localhost:9000 , or opensim://127.0.0.1:9000, or opensim://myipadress:9000

'''Linux'''
cd bin
mono OpenSim.exe

'''OSX'''
cd bin
mono OpenSim.exe

===Local Grid===
'''Windows'''
cd bin
OpenSim.Grid.UserServer.exe
OpenSim.Grid.GridServer.exe
OpenSim.Grid.AssetServer.exe
OpenSim.Grid.InventoryServer.exe
OpenSim.Grid.MessagingServer.exe
OpenSim.exe

'''Linux'''
cd bin
mono OpenSim.Grid.UserServer.exe
mono OpenSim.Grid.GridServer.exe
mono OpenSim.Grid.AssetServer.exe
mono OpenSim.Grid.InventoryServer.exe
mono OpenSim.Grid.MessagingServer.exe
mono OpenSim.exe

'''OSX'''
cd bin
mono OpenSim.Grid.UserServer.exe
mono OpenSim.Grid.GridServer.exe
mono OpenSim.Grid.AssetServer.exe
mono OpenSim.Grid.InventoryServer.exe
mono OpenSim.Grid.MessagingServer.exe
mono OpenSim.exe
Connect: opensim://myipaddress:9000

===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.

== 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]]

Configuration

2009-10-14T18:52:03Z

Taftr: /* Standalone mode */

__NOTOC__
{{Template:Quicklinks}}
 
== OpenSim Command line options ==
To run OpenSim in somewhat customized environments it's often helpful to modify the programs behaviour via command line arguments.
OpenSim knows a just a few of these as most parts of the behaviour are controlled via an .INI-File (see below).

The following command line switches are known:
{| border="1"
! Switch !! Meaning/Behaviour
|-
| background ||
|-
| gridmode || If =true forces OpenSim.exe to operate in grid mode. If =false forces OpenSim.exe to operate in standalone mode. If omitted defaults to OpenSim.ini setting.
|-
| gui || "old-style" console
|-
| inidirectory ||
|-
| inifile || changes the name (Path) of the inifile. See below for details
|-
| inimaster || allows to read in a master config file. See below for details
|-
| physics ||
|}

==OpenSim configuration file==
The 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. Detailed information on the options available for setttings in this file can be found [[OpenSim.ini|here]].
Please note, that the name OpenSim.ini can be changed via command line arguments (see above). Also, note that the default download does not include an OpenSim.ini file, but rather provides an example file. To get started editing your ini file, please cd into opensim/bin/ and copy OpenSim.ini.example to OpenSim.ini.

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 but some settings differ.
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.

==Standard config in Windows==
===0.6.6 Release Information===
This release had some bugs with default automatic configuration on the first startup of OpenSim.exe. bin/Regions/default.xml (region configuration file) is not automatically created in the main directory. Therefore, you must manually create this file. Here is an example.
<pre>
<Root>
<Config sim_UUID="UUID" sim_name="NAME" sim_location_x="1000" sim_location_y="1000"
internal_ip_address="IP_ADDRESS_OF_SERVER" internal_ip_port="9000" allow_alternate_ports="false"
external_host_name="DNS_NAME_OF_SERVER" master_avatar_uuid="00000000-0000-0000-0000-000000000000"
estate_covanant_uuid="00000000-0000-0000-0000-000000000000" master_avatar_first="FIRST_NAME"
master_avatar_last="SECOND_NAME" master_avatar_pass="PASSWORD" />
</Root>
</pre>
You must change UUID, NAME, IP_ADDRESS_OF_SERVER, DNS_NAME_OF_SERVER, FIRST_NAME, SECOND_NAME and PASSWORD to your own values.
(I noticed than IP_ADDRESS_OF_SERVER should be set to real IP not to 127.0.0.1)

'''Summary''':

*Run OpenSim0.6.6Setup.exe and install OpenSim in Windows
*Run OpenSim.exe and enter default values - record them!
*Shutdown simulator (command: shutdown)
*Create default.xml with copy of above
*Change values in default.xml with recoded values
*Be sure default.xml be in main directory (same with OpenSim.ini)
*Run again OpenSim.exe
*Connect with viewer

===Running OpenSim in 64 bit Windows on the future 0.6.7 release===
[[Image:Exclamation.png|left]]
In Git revision 077d01, the default physics engine for OpenSim was changed to the ODE engine. This is because ODE is by far the most advanced physics engine. Unfortunately, it has the drawback in that it's library is not compilable under 64bit. 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 ODE.

== Logging ==
Usually you don't have a debugger and the source code at hand when a situation comes up. OpenSim does some logging to give you information about how it works.
This is done by use of the [http://logging.apache.org/log4net/index.html log4net-package]. The obvious console output of OpenSim as well as the OpenSim.log output are done via this package and come readily configured out of the box. But you can also make extended use of all other options this package can give you.

OpenSim makes use of the .NET System.Configuration API which means that the file that holds all the logging configuration is bin/OpenSim.exe.config .

More information on how to configure log4net can be found on the [http://logging.apache.org/log4net/release/manual/configuration.html log4net web pages].

==Database==
Opensim's supports the following database-engines:
* 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.)
* MySQL (fully supported)
* MSSQL (partially supported - some recent OpenSim features may not yet be implemented)
* Postgresql (fully supported - Still in Beta phase but working)

More information on database support can be found on the [[OpenSim Database support]] page.

==Script engine==
OpenSim supports multiple script engines. See [[ScriptEngines]] for details

==Permissions Configuration==
OpenSim has a quite elaborate set of permissions. See [[OpenSim:Permissions(Server)]] for details.

==Standalone vs. Grid==
We recommend that you first get OpenSim running in standalone mode before you attempt to connect it to a grid, either your own grid or a public grid. An OpenSim configuration consists of regions (run by region simulators) and 5 core backend services (which manage users, the grid, assets, inventories, and grid-wide messaging, collectively known as UGAIM).

A system running in '''standalone mode''' (that is, one with OpenSim.ini configured such that gridmode = false) -- also known as "sandbox mode" -- runs everything (all UGAIM services and one or more regions) in a single executable (OpenSim.exe). External regions cannot be added to an OpenSim running in this mode.

In '''grid mode''', the five services ([[User Server|User]], [[Grid Server|Grid]], [[Asset Server|Asset]], [[Inventory Server|Inventory]], [[Messaging Server|Messaging]], or UGAIM) are not part of the region server. This means that they can be run either on the same machine or spread out across multiple computers. In this mode, OpenSim.exe serves one or more regions, which communicate with the core servers. This mode even allows region servers run by other people on their own machines to connect, if you wish.

Naturally, this means that running in grid mode is somewhat 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 are not difficult, but do require a little more care in setting things up.

If you want to run a grid of your own (either private or public) you would start the core services up before connecting a region simulator. If you want to connect your region server to a grid that someone else is running, you need only start the region server in grid mode (with the necessary security keys and location information mentioned in the last paragraph).

OpenSim.exe responds to various command line arguments. These include "-inifile", "-configfile", "-gridmode", "-physics", "-config" & "-noverbose". When starting OpenSim in either Windows or Linux, one could, for example, add "-physics=OpenDynamicsEngine" to run the OpenDynamicsEngine instead of basicphysics, or use "-gridmode=true" to force opensim.exe to run as a region server (the rest of the grid services have their own executables). As many of these settings are normally controlled by OpenSim.ini, most users (especially in standalone mode) will not add any command line arguments.

=== Standalone mode ===

When you start OpenSim in standalone mode, it will ask you several questions at the console. The first set of prompts that start with "NETWORK SERVERS INFO", you can just hit return to accept the defaults if you will be running in standalone mode. The prompts that start with "DEFAULT REGION CONFIG" are where you need to start paying attention. Some are self-explanatory. Here are explanations for the others: 

*Grid Location. OpenSim regions can be placed anywhere on a 65536 by 65536 grid. In standalone mode, it is safe to leave these X and Y locations at their defaults for the first region (additional regions will need different coordinates, of course).
*Filename for local storage. Safe to leave at default.
*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 IP port for incoming UDP client connection. 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 
*External host name. If you will only be attaching to your sim from a SecondLife client on the same machine, you can leave this at the default 127.0.0.1. If you will be wanting to connect to it from a client on another machine or the internet, this should be the External IP Address of your router, not the Domain Name. (Hmm - Tried hostname (the one resolved by dns) and it worked out oke.)
*Be aware of [http://osgrid.org/forums/viewtopic.php?f=5&t=400&start=0&st=0&sk=t&sd=a loopback] problems when Running viewer & server(s) on the same machine (LAN) by using the "external" configuration. ('''You might notice endless waiting for region handshake'''.) See also [http://opensimulator.org/wiki/Troubleshooting troubleshoot hints]

To connect to your new sim, start up secondlife with the following command line switches:

'''Client on same machine as OpenSim:''' -loginuri http://127.0.0.1:9000/ -loginpage http://127.0.0.1:9000/?method=login

Client on different machine or internet:''' -loginuri http://external_ip:9000/ -loginpage http://external_ip:9000/?method=login'''

To create a user:

type create user <first> <last> <password> <x_loc> <y_loc> in the server console. 

===Grid mode===
You want to run your own grid. Great! Assuming that you already got your sim running in standalone mode, here is what you need to do: 
1. Current builds of OpenSim grid mode are using mysql to store the grid information. You must have this installed and configured if you want to run your own grid. See [[mysql-config]] for more information. 

[[Image:Exclamation.png|left]]
NOTE: The grid servers are in the process of being redesigned. Therefore, there is a "legacy" way
and a new way of starting things. The most up to date information can be found in the configuration
file examples in your OpenSim kit.

The new system consists of services and connectors that are run in a server shell (Basic Universal
Server Technology, R.O.B.U.S.T.)

For information on running the legacy servers, see [[LegacyServers]]

===Starting the grid services===
Currently, R.O.B.U.S.T has connectors for the asset and inventory functionality. Therefore, some of the legacy servers are still required to run. Following the steps below will get you up and running in no time!

* 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, just press enter for all questions except fot the defult inventory server. The default inventory server needs to be given as http://127.0.0.1:8003, because R.O.B.U.S.T uses only one port.
::The user server will then load and display it's prompt:
User#
* Configure the grid server
::Start OpenSim.Grid.GridServer.exe
::Again, you will be asked a few questions and it's safe to accept the defaults if all servers are run on one machine. You will then see the grid server prompt:
Grid#
* Configure R.O.B.U.S.T.
::Copy OpenSim.Server.ini.example to OpenSim.Server.ini
::(on version 0.6.6 copy OpenSim.Services.ini.example to OpenSim.Services.ini - then use OpenSim.Services instead OpenSim.Server)
::Don't forget change ConnectionString accordingly your database settings.
Linux
bin$ cp OpenSim.Server.ini.example OpenSim.Server.ini
Windows
C:\OpenSim\bin> copy OpenSim.Server.ini.example OpenSim.Server.ini
For more information on the R.O.B.U.S.T. configuration file, refer to [[R.O.B.U.S.T.]]

::Start OpenSim.Server.exe
The server will start up it's asset and inventory components and display the R.O.B.U.S.T prompt:
R.O.B.U.S.T.#
* Configure the message server
::Start OpenSim.Grid.MessagingServer.exe
::Answer the configuration questions. Again, if all servers are run on the same machine, it's safe to press enter for all questions
::The server will start and present you with it's prompt:
Messaging#

===Starting the regions===
When using R.O.B.U.S.T., a setting that was not needed in standalone mode needs to be changed from it's default.
Open OpenSim.ini and find the section titled [Network]. Change the inventory_server_url to read http://127.0.0.1:8003.
[Network]
inventory_server_url = "http://127.0.0.1:8003"

Next, find the [Architecture] section, comment out the line that says
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.
copy the following files
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

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:
OpenSim.exe -gridmode=true
or:
mono OpenSim.exe -gridmode=true
With any luck, everything will come up without too many errors. 

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.

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:
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"''

==Multiple regions==
Using Physical Prim with the OpenDynamicsEngine on *nix, it's recommended that you set your stack reserve level higher then default with the following command;
<tt>ulimit -s 262144</tt> Or, run the opensim-ode.sh to start up OpenSimulator.

A powerful region generator is available at: [[RegionGenerator]]

For running multiple regions on the same box, you simply make multiple copies of the 'default.xml' file inside the <tt>bin/Regions/</tt> directory. You can do this by typing <tt>create region</tt> at the OpenSim command prompt, using the script <tt>make.php</tt> in <tt>share/regions</tt>, or you can generate the files by hand.

If you want to create the files by hand:

:first copy the default.xml file in the <tt>bin/Regions</tt> directory, and name them anything you want (I name mine region.x.y.xml, where region is the name of the region, and x and y are the grid coords.)
:Open each xml file and edit the uuid (a generator can be found at [http://www.famkruithof.net/uuid/uuidgen uuidgen webpage] or on unix, use the uuidgen command), region name, x & y positions, and internal IP port.

'''IMPORTANT!''' Regardless of the method you use to create your new region, the UUID, name, and grid coordinates ''must'' be unique for each region on a grid. The port assignment must be unique for each region that is running on a particular machine. The internal IP ''address'' and external host name must be the same for all regions.

Note that <tt>sim_location_x</tt> and <tt>sim_location_y</tt> should be adjacent integers if you want your regions to be adjacent, so you can run back and forth between them. '''IMPORTANT: THESE GRID COORDINATES ARE ''NOT'' IN METERS. THEY ARE SIM POSITIONS.''' (1000, 1000) is next to (1001,1000), (1000, 1001), and so forth. 1256, 2000, 2048 and similar values are '''not''' adjacent to 1000, they are very far away, so you would not see your sims from one another.

Once you have 2 or more xml files in the bin/Regions folder, running a ''single'' copy of <tt>OpenSim.exe</tt> will start up all of your sims! If you come across any errors, there is most likely an error in your xml files.

As of 6-Feb-2008, take care NOT to leave editor backup copies of the files in this directory e.g. emacs style backup names like Regionname.xml~. These are loaded by opensim.exe as if they are legitimate region descriptions, and will therefore give errors indicating you are trying to re-use the socket for that region.

==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>OpenSim.ini</tt> file in the <tt>bin</tt> directory. In that file, there is a <tt>[Network]</tt> section with URLs for the grid, user, and asset servers, as well as send and receive keys (for a basic level of security). The addresses and send/receive keys will vary depending on the grid you are connecting to, and the grid operator should tell you what values to use.

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>default.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]]

==Running==

===StandAlone===
'''Windows'''
cd bin
OpenSim.exe
On Windows Vista, it may be necessary to explicitly "Run as administrator" for opensim.exe to accept connections from a client, even when running as an administrator user. Navigate to the opensim\bin directory, right click opensim.exe, and select "Run as administrator".
Connect: opensim://localhost:9000 , or opensim://127.0.0.1:9000, or opensim://myipadress:9000

'''Linux'''
cd bin
mono OpenSim.exe

'''OSX'''
cd bin
mono OpenSim.exe

===Local Grid===
'''Windows'''
cd bin
OpenSim.Grid.UserServer.exe
OpenSim.Grid.GridServer.exe
OpenSim.Grid.AssetServer.exe
OpenSim.Grid.InventoryServer.exe
OpenSim.Grid.MessagingServer.exe
OpenSim.exe

'''Linux'''
cd bin
mono OpenSim.Grid.UserServer.exe
mono OpenSim.Grid.GridServer.exe
mono OpenSim.Grid.AssetServer.exe
mono OpenSim.Grid.InventoryServer.exe
mono OpenSim.Grid.MessagingServer.exe
mono OpenSim.exe

'''OSX'''
cd bin
mono OpenSim.Grid.UserServer.exe
mono OpenSim.Grid.GridServer.exe
mono OpenSim.Grid.AssetServer.exe
mono OpenSim.Grid.InventoryServer.exe
mono OpenSim.Grid.MessagingServer.exe
mono OpenSim.exe
Connect: opensim://myipaddress:9000

===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.

== 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]]