OpenSimulator - User contributions [en]

Varregion

2014-02-02T17:23:24Z

Smxy: /* Stuff to Work On */

'''Varregion'''

__TOC__
"Varregion" is a feature of OpenSimulator that enables region sizes larger than 256x256. The region is just larger so it acts like a regular region but with borders farther apart.

The implementation uses the [http://aurora-sim.org Aurora] large region protocol extensions so the existing [http://firestormviewer.org Firestorm] and [http://singularityviewer.org Singularity] Aurora support will now work for OpenSimulator.

A growing list of protocol changes to implement "varregion" is at [[varregion/Protocol|Varregion Protocol]].

==Restrictions==
Some restrictions apply:
* The dimensions must be a multiple of 256 and less than or equal to 8192.
* The dimensions must be square (as of 20131104)
* Adjacent regions must be the same size. For instance, you can have multiple 512x512 regions adjacent (and see into the other region and border cross). There seems to be a viewer problem where, if regions of different size are within view distance, crashes can happen. Consider having regions of only the same size 'in view'. Remember that the region coordinates are specified in 256m region count so a group of four 512x512 regions would be specified at 8000/8000, 8000/8002, 8002/8000, and 8002/8002, for instance.
* You must use BulletSim (as of 20131104, ODE has not been modified for varregions)
** You must use BulletSim's height map terrain implementation. As of 20140128, BulletSim has been modified to force heightmap terrain implementation if region size is greater than 256 on any side. The setting can be forced by adding to your INI files:
<pre>
[BulletSim]
TerrainImplementation = 0
</pre>

==Configuration==
The size is be specified in the <tt>Region.ini</tt> file:
<pre>
[MyRegionName]
RegionUUID = 95ec77ec-58c5-4ce2-9ff3-b6d1900d78a2
Location = 1000,1000
SizeX = 1024
SizeY = 1024
InternalAddress = 0.0.0.0
InternalPort = 9200
AllowAlternatePorts = False
ExternalHostName = SYSTEMIP
</pre>
If size is not specified, it will, of course, default to the legacy size of 256.

If the given dimensions do not fit the restrictions, acceptable values are computed and warning and error messages are output into the log.

If converting from a mega-region, remember to set "<tt>CombineContiguousRegions = false</tt>".

for llRezObject to work beyond 256m set "ScriptDistanceLimitFactor = 52.0" (for 512mx512m) in the [Xengine] section of OpenSim.ini.

The terrain heightmap is stored in the database as an array of 'shorts' (two bytes) so, if you have a very large region you might need to set the database maximum size to a larger value. For instance, a 2816x2816 region (11x11 legacy regions) turns into a 56 megabyte heightmap and, for MySQL, you would need to set <tt>max_allowed_packet</tt> to something like 64M.

==Loading Terrain==
The usual terrain console commands work with varregions. If you have set up a larger region, you can load BMP/RAW/PNG heightmap files of the dimensions of the region and fill the whole region. For instance, a 1024x1024 region terrain would be completely initialized by "terrain load 1024.bmp" if '1024.bmp is a 1024x1024 bitmap.

==Varregions and OAR Files==
The objects and terrain are stored in an OAR file as if it was one region. That is, if you save a 1024x1024 region in an OAR file, you can later restore the objects and terrain into a 1024x1024 sized region. If you load an OAR file from a smaller region into a larger region, the unspecified terrain space will default to 25m.

To make conversion to varregions easier, 'load oar' now has a '--displacement "<x,y,z>"' parameter. This displaces all of the objects and the terrain from the oar file when loading them into the new region. For instance, say you have four
OAR files from four adjacent 256x256 regions (oar00.oar, oar01.oar, oar10.oar, and oar11.oar). You create a new 512x512 varregion named 'bigregion'. The following commands place the four regions of objects, terrains and parcels
into the new larger region:

<pre>
change region bigregion
load oar oar00.oar
load oar --displacement "<0,256,0>" --merge --forceterrain --forceparcel oar01.oar
load oar --displacement "<256,0,0>" --merge --forceterrain --forceparcel oar10.oar
load oar --displacement "<256,256,0>" --merge --forceterrain --forceparcel oar11.oar
</pre>

Note the new "--forceterrain" and "--forceparcel" parameters. "--merge", used by itself, is for merging together the objects from multiple OARs. Merging also suppresses the loading of terrain and parcel data which is just what you want when merging objects. But, if loading multiple OARs to create a new, larger region, the terrain and parcel information must be loaded. Thus the new parameters.

==Things Known to be Broken==
* There is some problem with teleporting in an out of larger region. It works for some configurations and not others.
* While adjacent regions are usually viewable, sometimes they are not. They appear when you cross over into the region.

==Implementation Discussion==
Since this will be a major change to OpenSimulator that touches a
lot of different parts, subsequent posts, will discuss the changes I'm making.

===TerrainData===
One major problem is passing the terrain data from the region to the
protocol stack. The existing implementation passed an array of floats
that were presumed to be a 256x256 array of region terrain heights.
The
<tt>TerrainChannel</tt>
class is an attempt to hide the terrain implementation
from
<tt>TerrainModule</tt>
.
<tt>TerrainChannel</tt>
can't be passed into the protocol
stack (LLClientView) because
<tt>TerrainChannel</tt>
is defined as part of
<tt>OpenSim.Region.Framework</tt>
which is not visible to the protocol code.

My solution is to create the
<tt>TerrainData</tt>
class in
<tt>OpenSim.Framework.</tt>
<tt>TerrainData</tt>
just wraps the data structure for the terrain and additionally has
the attributes giving X and Y size.

I didn't want to change the signature of IClientAPI since so many external modules
rely on it.
It should be changed to pass <tt>TerrainData</tt> rather than a <tt>float[]</tt>.
I decided to not change IClientAPI but rather have <tt>LLClientView</tt> ignore
the passed array and instead reach back into the associated scene and fetch the
<tt>TerrainData</tt> instance.

There is one subclass of <tt>TerrainData</tt>: <tt>HeightmapTerrainData</tt> which keeps the terrain as a compressed heightmap. The height of each point is stored as a <tt>short</tt> which is <tt>height * compressionFactor</tt> where <tt>compressionFactor</tt> is usually "100". This creates a compact storage of the terrain heights with two decimal points of resolution.

The LLLP ("Linden Lab Legacy Protocol") sends terrain height data in
compressed "patches" of 16x16 areas of the terrain
height. This is a protocol feature that is implemented in <tt>TerrainChannel</tt>.
I feel that underlying protocol optimizations shouldn't appear up the
stack so, in creating <tt>TerrainData</tt>, I tried to hide terrain patches.
I mean, someday terrain will be generalized meshes. Right?

===Terrain in the Database===
Previously, terrain height maps were saved in the database as a blob of 256x256 doubles. To have different region sizes, that format had to change. There is an existing database field <tt>revision</tt> that stored the time the terrain was saved. This revision information wasn't used for anything so this field was co-opted to contain a revision code for the height field blob.

There are three forms for the height map blob: legacy, compressed2D and regular2D. "legacy" is, of course, the previous 256x256 collections of doubles. "regular2D" contains the X, Y dimensions and enough floats for that area's heights. "compressed2D" contains the X,Y and compressionFactor followed by enough shorts for the height map.

The database readers and writers default to the legacy format and, if the region happens to have the dimensions 256x256, it is stored using the legacy format. This is an attempt to keep downward compatibility.

All of the database modules (MySQL, SQLite, MSSQL and PSQL) have been modified to store terrain this new way.

===Sensing Border Crossing===
Most of the ‘move to new region’ code is based on checking boundaries. There is much code related to computing if an object or avatar has crossed a region boundary and then computing the address of the next region from same. Introducing variable sized regions messes a lot of this computation up. That is, the code doing the arithmetic usually assumes it knows the address of the next region based on a known region size and them can compute the location of the next region based on that. With varregions those assumptions no longer hold. Varregion implementation means that the computation of region base locations and border locations moves to the GridService who is the entity who really knows the size of all the regions and what is adjacent to what.

The realization that location to region computation is really a GridService operation lead me to totally rip apart the grid boundary checking code and replace it with two functions: <tt>Scene.PositionIsInCurrentRegion(Vector3 pos)</tt> and then <tt>EntityTransferModule.GetRegionContainingWorldLocation(double X, double Y)</tt>. The former function tests to see if the object/avatar has moved out of the current region and the latter gets the region moved into. (Side note: <tt>GetRegionContainingWorldLocation</tt> should really be a function on <tt>IGridService</tt> but that exercise is left for future hacking).

These changes leave all the 'border' code in limbo -- the generation of the border lists is still there but it is not being used. This should eventually be cleaned up. Also, the computation of neighbor regions is scattered around with routines on <tt>IGridService</tt>, in <tt>EntityTransferModule</tt> and a bunch of bookkeeping in <tt>Scene</tt>. This too should be cleaned up.

==Implementation Notes==

As of January 27, 2014, varregion is a feature of the 'master' repository branch.

===Stuff to Work On===
What follows are notes I am making as things that might need work are found in OpenSimulator.

* Consolidate neighbor region computation code (Scene, EntityTransferModule and IGridService all have 'get neighbor' code)
* Clean up/eliminate border list creation and use code
* Region handles are world coords and also the base of the region
** verify that everyone who converts coords to handle (Util.RegionWorldLocToHandle) is supplying the base of the region. (mostly done)
* ITerrainLoader implementations (mostly done)
** How to handle tiles.
** How to handle large regions sizes.
** Terrain/FileLoaders/*.cs all return an ITerrainChannel
** Need to fix all the file reader/writers
** FileLoaders/LLRAW.cs has several "256"s rather than constant references
* Teleporting: should be able to teleport to anywhere in a large region
** "MyRegion/550/687/40"
* HG code needs to allow addresses anywhere into large regions
* When GridService return adjacent regions, make sure it does the right thing for large regions
* Consider moving terrain XML serialization into TerrainData
* Consider removing all instances of TerrainChannel.GetFloatsSerialized()
** Replace with passing around TerrainData
* Code in EntityTransferModule that checks distance to decide if to make new connection
** search for references to 'Constants.RegionSize'
** Consider removing the distance code and replacing with call to grid service
* WorldMapModule.cs does a lot of arithmetic depending on constants that are really Contants.RegionSize
* Util.IsOutsideView uses Constants.RegionSize. Is use in ScenePresence a problem?
** Used in ScenePresence.AdjustKnownSeeds()
** Is this another instance like EntityTransferModule that needs to goto the grid service?
* Move all the short[] heightmap representation stuff into TerrainData.cs (partially done)
** Is it possible to move all the patch stuff out of TerrainModule/TerrainChannel?
** Clean up the use of m_revert. It looks like it is not saved after terrain is modified.
* Need to look through RegionCombinerModule.cs and see what safety checks are needed
** Maybe just prevent combination if not legacy region size
* In LSL_Api.cs, llEdgeOfWorld() does some neighbor computation. Check for ok'ness.
* LandManagementModule.SendParcelOverlay sends land sale/ownership info for 4x4m areas
** Looks like it expects to send exactly one 1024 byte block (for the 256x256 legacy region
** Check viewer code for what will happen for larger regions
* The code for cloud and wind needs to be enhanced for larger regions
** New overlay types added
* LLClientView.SendMapBlockSplit() needs to have region size to send with the map info
* Region/Framework/Scenes/Tests/BorderTests.cs might need work if non-standard regions are tested
* Verify terrain tests still work (for 256m regions)
* Region coords are sometimes 'int' and sometimes 'uint' with conversions EVERYWHERE
** pass over everything and convert region coordinates it 'uint's
** consider creating structures for world and region coordinates so there can be compile time checking

====Viewer====
* LLSurface is wired to expect adjacent regions of same size
* Terrain surface image is sized with a 'static": " static S32 sTextureSize; // Size of the surface texture"
* From FreeNode:#SingularityViewer 20131125:
<pre>
<Aleric> radams1, SianaGearz, frnic : I couldn't help myself doing a profile anyway.. The reason the viewer is slow is because it's busy "drawing" the terrain. "drawing" between quotes because my guess is that it is trying to draw ALL terrain and then clip that afterwards to the frustrum...
<Aleric> So, this could be greatly improved by disregarding terrain way way earlier when it is beyond the drawing range anyway.
<SianaGearz> OK
<Aleric> I disabled all rendering, even added a 'return' in terrain render
<Aleric> but.. no improvement of FPS!
<frnic> oops
<Aleric> LLSurfacePatch::updateVisibility() is still eating a lot of cpu.
<Aleric> LLSurface::updatePatchVisibilities does 97% of the calls to LLSurfacePatch::updateVisibility
<Aleric> which then spends most of it's time calling LLCamera::AABBInFrustumNoFarClip
</pre>
* Singularity commit for varregion: https://github.com/singularity-viewer/SingularityViewer/commit/ad8ea07a

==Testing==
* Terrain/parcel operations
** Default 256 standalone region
*** Clean database. Start single standalone region. Verify 'pimple' region. Verify one parcel. Flatten region.
*** Create parcels adjacent to each edge and standalone in middle. Change names of each parcel and verify. Restart simulator and verify parcels exist and work correctly.
*** Save five parcel region as OAR. Clear database. Restart region. Load oar. Verify 5 parcels of correct location, name and features.
** Adjacent 256 standalone regions
** 768x768 standalone region
** Changing land from 256 to 768
* Teleporting
* Adjacency
* Hypergrid

Varregion

2013-11-11T22:49:26Z

Smxy: /* Restrictions */

Network Settings

2011-12-31T18:53:35Z

Smxy:

{{Quicklinks}}
 

==OpenSim Grid - Ports for Grid Services - from version 0.7.0 ==

Ports used for Grid services (such as login, user control, grid management, asset services and inventory services, etc) are run within a ''Robust'' shell started by Robust.exe. They can be configured to state which port they run on, and the services can be run across multiple machines as desired to balance load.

But in a simple grid with all the Robust services running in a single Robust.exe shell it is normal to just use two ports for all services:

TCP/8002 - All externally and user accessible OpenSim services
TCP/8003 - All internal OpenSim services

Hence, 8002 should be accessible through your firewall, but in this simple setup 8003 can be behind a firewall.

==OpenSim Grid - Ports for Region Simulators==
One port must be open on any computer running an OpenSim.exe simulator that attaches to a grid. OpenSim.exe can be run on same computer (or one of computers) on which the Grid Services run, or on a separate computer. One OpenSim.exe can be used to run a number of regions, but each region must have its own unique port on that computer.

TCP+UDP/9000 - Default Port for First Simulator - grid, regions, and clients talk to these
TCP+UDP/9001 - Default Prot for Second Simulator - grid, regions, and clients talk to these
TCP+UDP/900x - Default Port for further Simulators...

In fact you can choose which port you prefer to use for each region on grid using the '''InternalPort''' parameter in the relevant Region description .ini file

XML-RPC communications, if enabled, are on the port specified in the [XMLRPC] section '''XmlRpcPort''' parameter (default port 20800).

TCP+UDP/20800 - Default Port for XML-RPC communications to a specific OpenSim.ini simulator (and all regions on it)

==OpenSim StandAlone==
* UDP+TCP/9000 - Services and the single region simulator are used via this single port

* Check your /bin/Regions/ directory which contain one or more Region description files. Three of the fields will specify the internal IP address or domain name, the external IP address or domain name, and the port to be used for the region (which must be unique for each region) - something like this:
InternalAddress = "0.0.0.0"
InternalPort = 9000
ExternalHostName = 82.73.39.77"

* Retrieve your [http://www.ip-adress.com/ external_host_name]
* Get your internal_ip_address (using 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.

==Optional and Add-on Module Specific Ports==

===FreeSWITCH Voice===

TCP+UDP 5060 - SIP Ports (5060 for default call profile)
TCP+UDP 1720 - H.323 ports for call setup

More details on the Freeswitch ports used and firewall configuration details are at:

* [[Freeswitch_Module#Firewall_Config]]
* http://wiki.freeswitch.org/wiki/Firewall

===Mumble Voice===

SIP Ports
ICE Ports

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

{| class="FCK__ShowTableBorders"
|-
| [[Image:Router config snapshot1.png|thumb|250px|1.Status]]
| [[Image:Router config snapshot2.png|thumb|250px|2.Advanced > Gaming]]
| [[Image:Router config snapshot3.png|thumb|250px|3.Routing]]
|}

{| class="FCK__ShowTableBorders"
|-
| [[Image:Router config snapshot4.png|thumb|250px|4.firewall]]
| [[Image:Router config snapshot5.png|thumb|250px|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.

 

== NAT LoopBack Routers Listings ==

[[NAT_Loopback_Routers|opensimulator.org/wiki/NAT_Loopback_Routers]]

==Historical - OpenSim Grid - Ports for Grid Services - up to version 0.6.9 ==

Note this is no longer the current version...

* 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 - Used in early releases for region-to-region communications

== VMware VMXNET3 NIC Issue ==

When running OpenSim in a 64-bit CentOS 6 VM under VMware ESXi 5, with the latest VMware Tools installed, and using the VMXNET3 vNIC, I (smxy) found that my viewer would consistently be disconnected from my grid at approximately 12 minutes after connecting (with the child agents dying sooner, as evidenced by regions turning red in the mini-map), with ACK timeouts reported at the region consoles. This behavior was 100% repeatable. I discovered that deleting the VMXNET3 vNIC and replacing it with the E1000 vNIC (and maintaining the same MAC address) eliminated the problem completely.

A few weeks later, I noticed someone (LilinEnyo) reporting ACK timeouts, in IRC. It turns out she was running "ubuntu 64bit" under ESXi 5, with VMware tools installed and using the VMXNET3 vNIC. In her case, the ACK timeouts were disconnecting her viewer at approximately 5 minutes after connecting. I had her switch to the E1000 vNIC and it eliminated the issue for her, too.

[[Category:Users]]

OpenSim.exe Command Line Options

2010-09-25T13:03:08Z

Smxy:

{{obsolete}}
{{content}}

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.

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 (deprecated from Opensim 0.7, use console instead)
|-
| console || If =basic declares interface as a simple command console (it has been noted that use of this can also avoid some terminal crashes when logging errors occur).
|-
| inidirectory ||
|-
| inifile || changes the name (Path) of the inifile.
|-
| inimaster || allows to read in a master config file.
|-
| logconfig || changes the name (Path) of the logfile.
|}

ROBUST

2009-10-10T12:45:07Z

Smxy: /* An Example Conversion From UGRM To URM */

==Redesigned OpenSim Basic Universal Server Technology (ROBUST)==
===Concepts===
ROBUST leverages the system of in and out connectors and services that was developed for the Hypergrid and OpenSim. It replaces OGS1 with a modular architecture that can be easily extended using core and 3rd party modules.

ROBUST is a flexible server shell that can load the same modules already used by regions. This allows for nearly 100% code reusability and great flexibility.

The ROBUST server loads "in" connectors as specified in the configuration file. These connectors then load the required processing and storage modules and/or "out" connectors. Through this architecture, each ROBUST server can run any or all grid services, and/or act as a proxy for grid services.

===Configuration===
The server reads a configuration file at startup, which defaults to the name of the assembly with .ini appended. The default name for the ROBUST server is OpenSim.Server.exe, therefore the default configuration file is OpenSim.Server.ini. An OpenSim.Server.ini.example file is provided with the OpenSim kit. The default port for all services running in ROBUST is 8003 as you can see below.

; * The startup section lists all the connectors to start up in this server
; * instance. This may be only one, or it may be the entire server suite.
; * Multiple connectors should be seaprated by commas.
; *
; * These are the IN connectors the server uses, the in connectors
; * read this config file and load the needed OUT and database connectors
; *
[Startup]
ServiceConnectors = "OpenSim.Server.Handlers.dll:AssetServiceConnector,OpenSim.Server.Handlers.dll:InventoryServiceInConnector"

; * This is common for all services, it's the network setup for the entire
; * server instance
; *
[Network]
port = 8003

; * As an example, the below configuration precisely mimicks the legacy
; * asset server. It is read by the asset IN connector (defined above)
; * and it then loads the OUT connector (a local database module). That,
; * in turn, reads the asset loader and database connection information
; *
[AssetService]
LocalServiceModule = "OpenSim.Services.AssetService.dll:AssetService"
DefaultAssetLoader = "OpenSim.Framework.AssetLoader.Filesystem.dll"
AssetLoaderArgs = "assets/AssetSets.xml"
StorageProvider = "OpenSim.Data.MySQL.dll"
ConnectionString = "Data Source=localhost;Database=grid;User ID=grid;Password=grid;"

; * This configuration loads the inventory server modules. It duplicates
; * the function of the legacy inventory server
; *
[InventoryService]
LocalServiceModule = "OpenSim.Services.InventoryService.dll:InventoryService"
UserServerURI = "http://127.0.0.1:8002"
SessionAuthentication = "false"
StorageProvider = "OpenSim.Data.MySQL.dll"
ConnectionString = "Data Source=localhost;Database=grid;User ID=grid;Password=grid;"

===Command Line Arguments===
*-inifile
:Specify the location of the .ini file to read instead of the default
*-console
:Specify console type, one of basic, local or rest
*-logfile
:Specify the logfile this server will log to
*-prompt
:Override the server prompt

==Configuration File==
===Section [Startup]===
*ServiceConnectors
:Comma separated list of service IN connectors. The format of each entry is <dllname>:<classname>. If a dll contains only one suitable class, the class name can be omitted.
*Prompt
:Override the server prompt
*Console
:Specify console type, one of basic, local or rest
*Logfile
:Specify the logfile this server will log to

===Section [Network]===
*Port
:Set the network port to listen on. All services will run on this port.

==Connector Configurations==
These configurations are provided by the connector modules and are not an integral part of the ROBUST server. Documentation to all possible options can be found in the documentation of the connector. This manual only lists the options present in the sample configuration file.

===Section [AssetService]===
* LocalServiceModule [Connector option]
:A module specification (<dll>:<class>) that provides the services for this connector
* DefaultAssetLoader [Service option]
:A dll containing the asset loader to use for loading the default asset set
* AssetLoaderArgs [Service option]
:Path to load assets from (for the file system asset loader)
* StorageProvider [Service option]
:Dll containing the database provider code
* ConnectionString [Service option]
:Connection string to be passed to the database provider

===Section [InventoryService]===
* LocalServiceModule [Connector option]
:A module specification (<dll>:<class>) that provides the services for this connector
* UserServerURI [Connector option]
:URI to reach the user server at
* SessionAuthentication [Connector option]
:Authenticate inventory sessions (default false!)
* StorageProvider [Service option]
:Dll containing the database provider code
* ConnectionString [Service option]
:Connection string to be passed to the database provider

Additional connectors may need additional sections to be added.

==An Example Conversion From UGAIM To UGRM==

Converting from UGAIM to UGRM:

Kudos to diva and Melanie_t for helping and tolerating me (smxy).

My initial setup:

Full HG-enabled, Internet-accessible, Grid Mode system, using MySQL and split over two servers.

UGAIM and MySQL 5.0 run in two separate 32-bit CentOS 5.3 Xen VMs on a 64-bit CentOS 5.3 system. 
Each region runs in its own instance of OpenSim.exe on a 32-bit Windows XP SP3 Home system. 
OSWI runs on the Windows system too.

Bring down the regions. Bring down UGAIM.

Then, the port for the inventory server needs to be changed from 8004 to 8003 in

OpenSim.ini: "inventory_server_url" - For all regions and the UGRM server. 
GridCommon.ini: "InventoryServerURI" - For all regions and the UGRM server. 
UserServer_Config.xml: "default_inventory_server" - For the UGRM server.

In the MySQL database, in the "users" table, the userInventoryURI field needs to be updated for all users.

In OSWI's config file, update "$userInventoryURI".

AssetServer_Config.xml and InventoryServer_Config.xml can be deleted from the UGRM server.

On the UGRM server, copy OpenSim.Server.ini.example to OpenSim.Server.ini and edit it, changing the "ConnectionString" entries appropriately, in the [AssetService] and [InventoryService] sections.

Bring up UGRM. Bring up regions.

Semi-unrelated Note: According to Melanie_t, any of the UGRM servers can be restarted independently,
without needing to restart the other three. However, if you restart the UserServer, you must issue
the command "register" (without the quotes) at the MessagingServer console, afterwards.

==An Example Conversion From UGRM To URM==

Converting from UGRM to URM:

This is a continuation of my "UGAIM to UGRM" example above. I may merge the two examples, eventually.

Bring down the regions. Bring down UGRM.

'''Make sure that you don't override any of these files - they should be used as they come out of the repository:'''
config-include/Grid.ini
config-include/GridHypergrid.ini
config-include/Standalone.ini
config-include/StandalioneHypergrid.ini

'''Also make sure that you include new additions in config-include/*Common.ini.example into your config-include/*Common.ini'''

Then, the port for the grid server needs to be changed from 8001 to 8003 in

UserServer_Config.xml: "default_grid_server" - For the URM server. 
MessagingServer_Config.xml: "default_grid_server" - For the URM server.

On the URM server, save a copy of your existing OpenSim.Server.ini. Copy OpenSim.Server.ini.example to OpenSim.Server.ini. Edit it to reflect any changes you made in the previous version. Then edit the "ConnectionString" entry, appropriately, in the [GridService] section.

GridServer_Config.xml can be deleted from the URM server.

Bring up URM. Bring up regions.

==Moving the Grid Server to its own ROBUST shell ==

Alternatively, if you have a large grid, you may want to run the grid service in its own ROBUST shell. If so, do this:

* Copy OpenSim.GridServer.ini.example to your own copy
* Edit it and change it so that it uses your regular Database and the usual Grid Server port
* Start U, then start the grid server like this:
$ OpenSim.Server.exe -inifile=OpenSim.GridServer.ini -logfile=/some/path/to/some/file
* Start AI and M as usual
* Start your sims

If you keep the grid server listening to the port you had before you don't need to change any other configuration files except to update the GridCommon.ini in the config-include folder as listed in the new GridCommon.ini.example.

ROBUST

2009-10-10T12:44:00Z

Smxy: /* An Example Conversion From UGRM To URM */

==Redesigned OpenSim Basic Universal Server Technology (ROBUST)==
===Concepts===
ROBUST leverages the system of in and out connectors and services that was developed for the Hypergrid and OpenSim. It replaces OGS1 with a modular architecture that can be easily extended using core and 3rd party modules.

ROBUST is a flexible server shell that can load the same modules already used by regions. This allows for nearly 100% code reusability and great flexibility.

The ROBUST server loads "in" connectors as specified in the configuration file. These connectors then load the required processing and storage modules and/or "out" connectors. Through this architecture, each ROBUST server can run any or all grid services, and/or act as a proxy for grid services.

===Configuration===
The server reads a configuration file at startup, which defaults to the name of the assembly with .ini appended. The default name for the ROBUST server is OpenSim.Server.exe, therefore the default configuration file is OpenSim.Server.ini. An OpenSim.Server.ini.example file is provided with the OpenSim kit. The default port for all services running in ROBUST is 8003 as you can see below.

; * The startup section lists all the connectors to start up in this server
; * instance. This may be only one, or it may be the entire server suite.
; * Multiple connectors should be seaprated by commas.
; *
; * These are the IN connectors the server uses, the in connectors
; * read this config file and load the needed OUT and database connectors
; *
[Startup]
ServiceConnectors = "OpenSim.Server.Handlers.dll:AssetServiceConnector,OpenSim.Server.Handlers.dll:InventoryServiceInConnector"

; * This is common for all services, it's the network setup for the entire
; * server instance
; *
[Network]
port = 8003

; * As an example, the below configuration precisely mimicks the legacy
; * asset server. It is read by the asset IN connector (defined above)
; * and it then loads the OUT connector (a local database module). That,
; * in turn, reads the asset loader and database connection information
; *
[AssetService]
LocalServiceModule = "OpenSim.Services.AssetService.dll:AssetService"
DefaultAssetLoader = "OpenSim.Framework.AssetLoader.Filesystem.dll"
AssetLoaderArgs = "assets/AssetSets.xml"
StorageProvider = "OpenSim.Data.MySQL.dll"
ConnectionString = "Data Source=localhost;Database=grid;User ID=grid;Password=grid;"

; * This configuration loads the inventory server modules. It duplicates
; * the function of the legacy inventory server
; *
[InventoryService]
LocalServiceModule = "OpenSim.Services.InventoryService.dll:InventoryService"
UserServerURI = "http://127.0.0.1:8002"
SessionAuthentication = "false"
StorageProvider = "OpenSim.Data.MySQL.dll"
ConnectionString = "Data Source=localhost;Database=grid;User ID=grid;Password=grid;"

===Command Line Arguments===
*-inifile
:Specify the location of the .ini file to read instead of the default
*-console
:Specify console type, one of basic, local or rest
*-logfile
:Specify the logfile this server will log to
*-prompt
:Override the server prompt

==Configuration File==
===Section [Startup]===
*ServiceConnectors
:Comma separated list of service IN connectors. The format of each entry is <dllname>:<classname>. If a dll contains only one suitable class, the class name can be omitted.
*Prompt
:Override the server prompt
*Console
:Specify console type, one of basic, local or rest
*Logfile
:Specify the logfile this server will log to

===Section [Network]===
*Port
:Set the network port to listen on. All services will run on this port.

==Connector Configurations==
These configurations are provided by the connector modules and are not an integral part of the ROBUST server. Documentation to all possible options can be found in the documentation of the connector. This manual only lists the options present in the sample configuration file.

===Section [AssetService]===
* LocalServiceModule [Connector option]
:A module specification (<dll>:<class>) that provides the services for this connector
* DefaultAssetLoader [Service option]
:A dll containing the asset loader to use for loading the default asset set
* AssetLoaderArgs [Service option]
:Path to load assets from (for the file system asset loader)
* StorageProvider [Service option]
:Dll containing the database provider code
* ConnectionString [Service option]
:Connection string to be passed to the database provider

===Section [InventoryService]===
* LocalServiceModule [Connector option]
:A module specification (<dll>:<class>) that provides the services for this connector
* UserServerURI [Connector option]
:URI to reach the user server at
* SessionAuthentication [Connector option]
:Authenticate inventory sessions (default false!)
* StorageProvider [Service option]
:Dll containing the database provider code
* ConnectionString [Service option]
:Connection string to be passed to the database provider

Additional connectors may need additional sections to be added.

==An Example Conversion From UGAIM To UGRM==

Converting from UGAIM to UGRM:

Kudos to diva and Melanie_t for helping and tolerating me (smxy).

My initial setup:

Full HG-enabled, Internet-accessible, Grid Mode system, using MySQL and split over two servers.

UGAIM and MySQL 5.0 run in two separate 32-bit CentOS 5.3 Xen VMs on a 64-bit CentOS 5.3 system. 
Each region runs in its own instance of OpenSim.exe on a 32-bit Windows XP SP3 Home system. 
OSWI runs on the Windows system too.

Bring down the regions. Bring down UGAIM.

Then, the port for the inventory server needs to be changed from 8004 to 8003 in

OpenSim.ini: "inventory_server_url" - For all regions and the UGRM server. 
GridCommon.ini: "InventoryServerURI" - For all regions and the UGRM server. 
UserServer_Config.xml: "default_inventory_server" - For the UGRM server.

In the MySQL database, in the "users" table, the userInventoryURI field needs to be updated for all users.

In OSWI's config file, update "$userInventoryURI".

AssetServer_Config.xml and InventoryServer_Config.xml can be deleted from the UGRM server.

On the UGRM server, copy OpenSim.Server.ini.example to OpenSim.Server.ini and edit it, changing the "ConnectionString" entries appropriately, in the [AssetService] and [InventoryService] sections.

Bring up UGRM. Bring up regions.

Semi-unrelated Note: According to Melanie_t, any of the UGRM servers can be restarted independently,
without needing to restart the other three. However, if you restart the UserServer, you must issue
the command "register" (without the quotes) at the MessagingServer console, afterwards.

==An Example Conversion From UGRM To URM==

Converting from UGRM to URM:

This is a continuation of my "UGAIM to UGRM" example above. I may merge the two examples, eventually.

Bring down the regions. Bring down UGRM.

'''Make sure that you don't override any of these files, they should be used as they come out of the repository:'''
config-include/Grid.ini
config-include/GridHypergrid.ini
config-include/Standalone.ini
config-include/StandalioneHypergrid.ini

'''Also make sure that you include new additions in config-include/*Common.ini.example into your config-include/*Common.ini'''

Then, the port for the grid server needs to be changed from 8001 to 8003 in

UserServer_Config.xml: "default_grid_server" - For the URM server. 
MessagingServer_Config.xml: "default_grid_server" - For the URM server.

On the URM server, save a copy of your existing OpenSim.Server.ini. Copy OpenSim.Server.ini.example to OpenSim.Server.ini. Edit it to reflect any changes you made in the previous version. Then edit the "ConnectionString" entry, appropriately, in the [GridService] section.

GridServer_Config.xml can be deleted from the URM server.

Bring up URM. Bring up regions.

==Moving the Grid Server to its own ROBUST shell ==

Alternatively, if you have a large grid, you may want to run the grid service in its own ROBUST shell. If so, do this:

* Copy OpenSim.GridServer.ini.example to your own copy
* Edit it and change it so that it uses your regular Database and the usual Grid Server port
* Start U, then start the grid server like this:
$ OpenSim.Server.exe -inifile=OpenSim.GridServer.ini -logfile=/some/path/to/some/file
* Start AI and M as usual
* Start your sims

If you keep the grid server listening to the port you had before you don't need to change any other configuration files except to update the GridCommon.ini in the config-include folder as listed in the new GridCommon.ini.example.

ROBUST

2009-10-10T12:43:10Z

Smxy: /* An Example Conversion From UGRM To URM */

==Redesigned OpenSim Basic Universal Server Technology (ROBUST)==
===Concepts===
ROBUST leverages the system of in and out connectors and services that was developed for the Hypergrid and OpenSim. It replaces OGS1 with a modular architecture that can be easily extended using core and 3rd party modules.

ROBUST is a flexible server shell that can load the same modules already used by regions. This allows for nearly 100% code reusability and great flexibility.

The ROBUST server loads "in" connectors as specified in the configuration file. These connectors then load the required processing and storage modules and/or "out" connectors. Through this architecture, each ROBUST server can run any or all grid services, and/or act as a proxy for grid services.

===Configuration===
The server reads a configuration file at startup, which defaults to the name of the assembly with .ini appended. The default name for the ROBUST server is OpenSim.Server.exe, therefore the default configuration file is OpenSim.Server.ini. An OpenSim.Server.ini.example file is provided with the OpenSim kit. The default port for all services running in ROBUST is 8003 as you can see below.

; * The startup section lists all the connectors to start up in this server
; * instance. This may be only one, or it may be the entire server suite.
; * Multiple connectors should be seaprated by commas.
; *
; * These are the IN connectors the server uses, the in connectors
; * read this config file and load the needed OUT and database connectors
; *
[Startup]
ServiceConnectors = "OpenSim.Server.Handlers.dll:AssetServiceConnector,OpenSim.Server.Handlers.dll:InventoryServiceInConnector"

; * This is common for all services, it's the network setup for the entire
; * server instance
; *
[Network]
port = 8003

; * As an example, the below configuration precisely mimicks the legacy
; * asset server. It is read by the asset IN connector (defined above)
; * and it then loads the OUT connector (a local database module). That,
; * in turn, reads the asset loader and database connection information
; *
[AssetService]
LocalServiceModule = "OpenSim.Services.AssetService.dll:AssetService"
DefaultAssetLoader = "OpenSim.Framework.AssetLoader.Filesystem.dll"
AssetLoaderArgs = "assets/AssetSets.xml"
StorageProvider = "OpenSim.Data.MySQL.dll"
ConnectionString = "Data Source=localhost;Database=grid;User ID=grid;Password=grid;"

; * This configuration loads the inventory server modules. It duplicates
; * the function of the legacy inventory server
; *
[InventoryService]
LocalServiceModule = "OpenSim.Services.InventoryService.dll:InventoryService"
UserServerURI = "http://127.0.0.1:8002"
SessionAuthentication = "false"
StorageProvider = "OpenSim.Data.MySQL.dll"
ConnectionString = "Data Source=localhost;Database=grid;User ID=grid;Password=grid;"

===Command Line Arguments===
*-inifile
:Specify the location of the .ini file to read instead of the default
*-console
:Specify console type, one of basic, local or rest
*-logfile
:Specify the logfile this server will log to
*-prompt
:Override the server prompt

==Configuration File==
===Section [Startup]===
*ServiceConnectors
:Comma separated list of service IN connectors. The format of each entry is <dllname>:<classname>. If a dll contains only one suitable class, the class name can be omitted.
*Prompt
:Override the server prompt
*Console
:Specify console type, one of basic, local or rest
*Logfile
:Specify the logfile this server will log to

===Section [Network]===
*Port
:Set the network port to listen on. All services will run on this port.

==Connector Configurations==
These configurations are provided by the connector modules and are not an integral part of the ROBUST server. Documentation to all possible options can be found in the documentation of the connector. This manual only lists the options present in the sample configuration file.

===Section [AssetService]===
* LocalServiceModule [Connector option]
:A module specification (<dll>:<class>) that provides the services for this connector
* DefaultAssetLoader [Service option]
:A dll containing the asset loader to use for loading the default asset set
* AssetLoaderArgs [Service option]
:Path to load assets from (for the file system asset loader)
* StorageProvider [Service option]
:Dll containing the database provider code
* ConnectionString [Service option]
:Connection string to be passed to the database provider

===Section [InventoryService]===
* LocalServiceModule [Connector option]
:A module specification (<dll>:<class>) that provides the services for this connector
* UserServerURI [Connector option]
:URI to reach the user server at
* SessionAuthentication [Connector option]
:Authenticate inventory sessions (default false!)
* StorageProvider [Service option]
:Dll containing the database provider code
* ConnectionString [Service option]
:Connection string to be passed to the database provider

Additional connectors may need additional sections to be added.

==An Example Conversion From UGAIM To UGRM==

Converting from UGAIM to UGRM:

Kudos to diva and Melanie_t for helping and tolerating me (smxy).

My initial setup:

Full HG-enabled, Internet-accessible, Grid Mode system, using MySQL and split over two servers.

UGAIM and MySQL 5.0 run in two separate 32-bit CentOS 5.3 Xen VMs on a 64-bit CentOS 5.3 system. 
Each region runs in its own instance of OpenSim.exe on a 32-bit Windows XP SP3 Home system. 
OSWI runs on the Windows system too.

Bring down the regions. Bring down UGAIM.

Then, the port for the inventory server needs to be changed from 8004 to 8003 in

OpenSim.ini: "inventory_server_url" - For all regions and the UGRM server. 
GridCommon.ini: "InventoryServerURI" - For all regions and the UGRM server. 
UserServer_Config.xml: "default_inventory_server" - For the UGRM server.

In the MySQL database, in the "users" table, the userInventoryURI field needs to be updated for all users.

In OSWI's config file, update "$userInventoryURI".

AssetServer_Config.xml and InventoryServer_Config.xml can be deleted from the UGRM server.

On the UGRM server, copy OpenSim.Server.ini.example to OpenSim.Server.ini and edit it, changing the "ConnectionString" entries appropriately, in the [AssetService] and [InventoryService] sections.

Bring up UGRM. Bring up regions.

Semi-unrelated Note: According to Melanie_t, any of the UGRM servers can be restarted independently,
without needing to restart the other three. However, if you restart the UserServer, you must issue
the command "register" (without the quotes) at the MessagingServer console, afterwards.

==An Example Conversion From UGRM To URM==

Converting from UGRM to URM:

This is a continuation of my "UGAIM to UGRM" example above. Eventually, I will merge the two examples.

Bring down the regions. Bring down UGRM.

'''Make sure that you don't override any of these files, they should be used as they come out of the repository:'''
config-include/Grid.ini
config-include/GridHypergrid.ini
config-include/Standalone.ini
config-include/StandalioneHypergrid.ini

'''Also make sure that you include new additions in config-include/*Common.ini.example into your config-include/*Common.ini'''

Then, the port for the grid server needs to be changed from 8001 to 8003 in

UserServer_Config.xml: "default_grid_server" - For the URM server. 
MessagingServer_Config.xml: "default_grid_server" - For the URM server.

On the URM server, save a copy of your existing OpenSim.Server.ini. Copy OpenSim.Server.ini.example to OpenSim.Server.ini. Edit it to reflect any changes you made in the previous version. Then edit the "ConnectionString" entry, appropriately, in the [GridService] section.

GridServer_Config.xml can be deleted from the URM server.

Bring up URM. Bring up regions.

==Moving the Grid Server to its own ROBUST shell ==

Alternatively, if you have a large grid, you may want to run the grid service in its own ROBUST shell. If so, do this:

* Copy OpenSim.GridServer.ini.example to your own copy
* Edit it and change it so that it uses your regular Database and the usual Grid Server port
* Start U, then start the grid server like this:
$ OpenSim.Server.exe -inifile=OpenSim.GridServer.ini -logfile=/some/path/to/some/file
* Start AI and M as usual
* Start your sims

If you keep the grid server listening to the port you had before you don't need to change any other configuration files except to update the GridCommon.ini in the config-include folder as listed in the new GridCommon.ini.example.

ROBUST

2009-10-10T12:42:14Z

Smxy: /* An Example Conversion From UGAIM To UGRM */

==Redesigned OpenSim Basic Universal Server Technology (ROBUST)==
===Concepts===
ROBUST leverages the system of in and out connectors and services that was developed for the Hypergrid and OpenSim. It replaces OGS1 with a modular architecture that can be easily extended using core and 3rd party modules.

ROBUST is a flexible server shell that can load the same modules already used by regions. This allows for nearly 100% code reusability and great flexibility.

The ROBUST server loads "in" connectors as specified in the configuration file. These connectors then load the required processing and storage modules and/or "out" connectors. Through this architecture, each ROBUST server can run any or all grid services, and/or act as a proxy for grid services.

===Configuration===
The server reads a configuration file at startup, which defaults to the name of the assembly with .ini appended. The default name for the ROBUST server is OpenSim.Server.exe, therefore the default configuration file is OpenSim.Server.ini. An OpenSim.Server.ini.example file is provided with the OpenSim kit. The default port for all services running in ROBUST is 8003 as you can see below.

; * The startup section lists all the connectors to start up in this server
; * instance. This may be only one, or it may be the entire server suite.
; * Multiple connectors should be seaprated by commas.
; *
; * These are the IN connectors the server uses, the in connectors
; * read this config file and load the needed OUT and database connectors
; *
[Startup]
ServiceConnectors = "OpenSim.Server.Handlers.dll:AssetServiceConnector,OpenSim.Server.Handlers.dll:InventoryServiceInConnector"

; * This is common for all services, it's the network setup for the entire
; * server instance
; *
[Network]
port = 8003

; * As an example, the below configuration precisely mimicks the legacy
; * asset server. It is read by the asset IN connector (defined above)
; * and it then loads the OUT connector (a local database module). That,
; * in turn, reads the asset loader and database connection information
; *
[AssetService]
LocalServiceModule = "OpenSim.Services.AssetService.dll:AssetService"
DefaultAssetLoader = "OpenSim.Framework.AssetLoader.Filesystem.dll"
AssetLoaderArgs = "assets/AssetSets.xml"
StorageProvider = "OpenSim.Data.MySQL.dll"
ConnectionString = "Data Source=localhost;Database=grid;User ID=grid;Password=grid;"

; * This configuration loads the inventory server modules. It duplicates
; * the function of the legacy inventory server
; *
[InventoryService]
LocalServiceModule = "OpenSim.Services.InventoryService.dll:InventoryService"
UserServerURI = "http://127.0.0.1:8002"
SessionAuthentication = "false"
StorageProvider = "OpenSim.Data.MySQL.dll"
ConnectionString = "Data Source=localhost;Database=grid;User ID=grid;Password=grid;"

===Command Line Arguments===
*-inifile
:Specify the location of the .ini file to read instead of the default
*-console
:Specify console type, one of basic, local or rest
*-logfile
:Specify the logfile this server will log to
*-prompt
:Override the server prompt

==Configuration File==
===Section [Startup]===
*ServiceConnectors
:Comma separated list of service IN connectors. The format of each entry is <dllname>:<classname>. If a dll contains only one suitable class, the class name can be omitted.
*Prompt
:Override the server prompt
*Console
:Specify console type, one of basic, local or rest
*Logfile
:Specify the logfile this server will log to

===Section [Network]===
*Port
:Set the network port to listen on. All services will run on this port.

==Connector Configurations==
These configurations are provided by the connector modules and are not an integral part of the ROBUST server. Documentation to all possible options can be found in the documentation of the connector. This manual only lists the options present in the sample configuration file.

===Section [AssetService]===
* LocalServiceModule [Connector option]
:A module specification (<dll>:<class>) that provides the services for this connector
* DefaultAssetLoader [Service option]
:A dll containing the asset loader to use for loading the default asset set
* AssetLoaderArgs [Service option]
:Path to load assets from (for the file system asset loader)
* StorageProvider [Service option]
:Dll containing the database provider code
* ConnectionString [Service option]
:Connection string to be passed to the database provider

===Section [InventoryService]===
* LocalServiceModule [Connector option]
:A module specification (<dll>:<class>) that provides the services for this connector
* UserServerURI [Connector option]
:URI to reach the user server at
* SessionAuthentication [Connector option]
:Authenticate inventory sessions (default false!)
* StorageProvider [Service option]
:Dll containing the database provider code
* ConnectionString [Service option]
:Connection string to be passed to the database provider

Additional connectors may need additional sections to be added.

==An Example Conversion From UGAIM To UGRM==

Converting from UGAIM to UGRM:

Kudos to diva and Melanie_t for helping and tolerating me (smxy).

My initial setup:

Full HG-enabled, Internet-accessible, Grid Mode system, using MySQL and split over two servers.

UGAIM and MySQL 5.0 run in two separate 32-bit CentOS 5.3 Xen VMs on a 64-bit CentOS 5.3 system. 
Each region runs in its own instance of OpenSim.exe on a 32-bit Windows XP SP3 Home system. 
OSWI runs on the Windows system too.

Bring down the regions. Bring down UGAIM.

Then, the port for the inventory server needs to be changed from 8004 to 8003 in

OpenSim.ini: "inventory_server_url" - For all regions and the UGRM server. 
GridCommon.ini: "InventoryServerURI" - For all regions and the UGRM server. 
UserServer_Config.xml: "default_inventory_server" - For the UGRM server.

In the MySQL database, in the "users" table, the userInventoryURI field needs to be updated for all users.

In OSWI's config file, update "$userInventoryURI".

AssetServer_Config.xml and InventoryServer_Config.xml can be deleted from the UGRM server.

On the UGRM server, copy OpenSim.Server.ini.example to OpenSim.Server.ini and edit it, changing the "ConnectionString" entries appropriately, in the [AssetService] and [InventoryService] sections.

Bring up UGRM. Bring up regions.

Semi-unrelated Note: According to Melanie_t, any of the UGRM servers can be restarted independently,
without needing to restart the other three. However, if you restart the UserServer, you must issue
the command "register" (without the quotes) at the MessagingServer console, afterwards.

==An Example Conversion From UGRM To URM==

Converting from UGRM to URM:

This is a continuation of my "UGAIM to UGRM" example above. Eventually, I will merge the two examples.

Bring down the regions. Bring down UGRM.

'''Make sure that you don't override any of these files, they should be used as they come out of the repository:'''
config-include/Grid.ini
config-include/GridHypergrid.ini
config-include/Standalone.ini
config-include/StandalioneHypergrid.ini

'''Also make sure that you include new additions in config-include/*Common.ini.example into your config-include/*Common.ini'''

Then, the port for the grid server needs to be changed from 8001 to 8003 in a number of places:

UserServer_Config.xml: "default_grid_server" - For the URM server. 
MessagingServer_Config.xml: "default_grid_server" - For the URM server.

On the URM server, save a copy of your existing OpenSim.Server.ini. Copy OpenSim.Server.ini.example to OpenSim.Server.ini. Edit it to reflect any changes you made in the previous version. Then edit the "ConnectionString" entry, appropriately, in the [GridService] section.

GridServer_Config.xml can be deleted from the URM server.

Bring up URM. Bring up regions.

==Moving the Grid Server to its own ROBUST shell ==

Alternatively, if you have a large grid, you may want to run the grid service in its own ROBUST shell. If so, do this:

* Copy OpenSim.GridServer.ini.example to your own copy
* Edit it and change it so that it uses your regular Database and the usual Grid Server port
* Start U, then start the grid server like this:
$ OpenSim.Server.exe -inifile=OpenSim.GridServer.ini -logfile=/some/path/to/some/file
* Start AI and M as usual
* Start your sims

If you keep the grid server listening to the port you had before you don't need to change any other configuration files except to update the GridCommon.ini in the config-include folder as listed in the new GridCommon.ini.example.

ROBUST

2009-10-10T12:38:57Z

Smxy: /* An Example Conversion From UGRM To URM */

==Redesigned OpenSim Basic Universal Server Technology (ROBUST)==
===Concepts===
ROBUST leverages the system of in and out connectors and services that was developed for the Hypergrid and OpenSim. It replaces OGS1 with a modular architecture that can be easily extended using core and 3rd party modules.

ROBUST is a flexible server shell that can load the same modules already used by regions. This allows for nearly 100% code reusability and great flexibility.

The ROBUST server loads "in" connectors as specified in the configuration file. These connectors then load the required processing and storage modules and/or "out" connectors. Through this architecture, each ROBUST server can run any or all grid services, and/or act as a proxy for grid services.

===Configuration===
The server reads a configuration file at startup, which defaults to the name of the assembly with .ini appended. The default name for the ROBUST server is OpenSim.Server.exe, therefore the default configuration file is OpenSim.Server.ini. An OpenSim.Server.ini.example file is provided with the OpenSim kit. The default port for all services running in ROBUST is 8003 as you can see below.

; * The startup section lists all the connectors to start up in this server
; * instance. This may be only one, or it may be the entire server suite.
; * Multiple connectors should be seaprated by commas.
; *
; * These are the IN connectors the server uses, the in connectors
; * read this config file and load the needed OUT and database connectors
; *
[Startup]
ServiceConnectors = "OpenSim.Server.Handlers.dll:AssetServiceConnector,OpenSim.Server.Handlers.dll:InventoryServiceInConnector"

; * This is common for all services, it's the network setup for the entire
; * server instance
; *
[Network]
port = 8003

; * As an example, the below configuration precisely mimicks the legacy
; * asset server. It is read by the asset IN connector (defined above)
; * and it then loads the OUT connector (a local database module). That,
; * in turn, reads the asset loader and database connection information
; *
[AssetService]
LocalServiceModule = "OpenSim.Services.AssetService.dll:AssetService"
DefaultAssetLoader = "OpenSim.Framework.AssetLoader.Filesystem.dll"
AssetLoaderArgs = "assets/AssetSets.xml"
StorageProvider = "OpenSim.Data.MySQL.dll"
ConnectionString = "Data Source=localhost;Database=grid;User ID=grid;Password=grid;"

; * This configuration loads the inventory server modules. It duplicates
; * the function of the legacy inventory server
; *
[InventoryService]
LocalServiceModule = "OpenSim.Services.InventoryService.dll:InventoryService"
UserServerURI = "http://127.0.0.1:8002"
SessionAuthentication = "false"
StorageProvider = "OpenSim.Data.MySQL.dll"
ConnectionString = "Data Source=localhost;Database=grid;User ID=grid;Password=grid;"

===Command Line Arguments===
*-inifile
:Specify the location of the .ini file to read instead of the default
*-console
:Specify console type, one of basic, local or rest
*-logfile
:Specify the logfile this server will log to
*-prompt
:Override the server prompt

==Configuration File==
===Section [Startup]===
*ServiceConnectors
:Comma separated list of service IN connectors. The format of each entry is <dllname>:<classname>. If a dll contains only one suitable class, the class name can be omitted.
*Prompt
:Override the server prompt
*Console
:Specify console type, one of basic, local or rest
*Logfile
:Specify the logfile this server will log to

===Section [Network]===
*Port
:Set the network port to listen on. All services will run on this port.

==Connector Configurations==
These configurations are provided by the connector modules and are not an integral part of the ROBUST server. Documentation to all possible options can be found in the documentation of the connector. This manual only lists the options present in the sample configuration file.

===Section [AssetService]===
* LocalServiceModule [Connector option]
:A module specification (<dll>:<class>) that provides the services for this connector
* DefaultAssetLoader [Service option]
:A dll containing the asset loader to use for loading the default asset set
* AssetLoaderArgs [Service option]
:Path to load assets from (for the file system asset loader)
* StorageProvider [Service option]
:Dll containing the database provider code
* ConnectionString [Service option]
:Connection string to be passed to the database provider

===Section [InventoryService]===
* LocalServiceModule [Connector option]
:A module specification (<dll>:<class>) that provides the services for this connector
* UserServerURI [Connector option]
:URI to reach the user server at
* SessionAuthentication [Connector option]
:Authenticate inventory sessions (default false!)
* StorageProvider [Service option]
:Dll containing the database provider code
* ConnectionString [Service option]
:Connection string to be passed to the database provider

Additional connectors may need additional sections to be added.

==An Example Conversion From UGAIM To UGRM==

Converting from UGAIM to UGRM:

Kudos to diva and Melanie_t for helping and tolerating me (smxy).

My initial setup:

Full HG-enabled, Internet-accessible, Grid Mode system, using MySQL and split over two servers.

UGAIM and MySQL 5.0 run in two separate 32-bit CentOS 5.3 Xen VMs on a 64-bit CentOS 5.3 system. 
Each region runs in its own instance of OpenSim.exe on a 32-bit Windows XP SP3 Home system. 
OSWI runs on the Windows system too.

Bring down the regions. Bring down UGAIM.

Then, the port for the inventory server needs to be changed from 8004 to 8003 in

OpenSim.ini: "inventory_server_url" - For all regions and the UGRM server. 
GridCommon.ini: "InventoryServerURI" - For all regions and the UGRM server. 
UserServer_Config.xml: "default_inventory_server" - For the UGRM server.

In the MySQL database, in the "users" table, the userInventoryURI field needs to be updated for all users.

In OSWI's config file, update "$userInventoryURI".

AssetServer_Config.xml and InventoryServer_Config.xml can be deleted from the UGRM server.

On the UGRM server, copy OpenSim.Server.ini.example to OpenSim.Server.ini and edit it, changing the "ConnectionString" entries appropriately, in the [AssetService] and [InventoryService] sections.

Bring up UGRM. Bring up regions.

Semi-unrelated Note: According to Melanie_t, any of the UGRM servers can be restarted independently,
without needing to restart the other three. However, if you restart the UserServer, you must issue
the command "register" (without the quotes) at the MessagingServer console, afterwards.

==An Example Conversion From UGRM To URM==

Converting from UGRM to URM:

This is a continuation of my "UGAIM to UGRM" example above. Eventually, I will merge the two examples.

Bring down the regions. Bring down UGRM.

'''Make sure that you don't override any of these files, they should be used as they come out of the repository:'''
config-include/Grid.ini
config-include/GridHypergrid.ini
config-include/Standalone.ini
config-include/StandalioneHypergrid.ini

'''Also make sure that you include new additions in config-include/*Common.ini.example into your config-include/*Common.ini'''

Then, the port for the grid server needs to be changed from 8001 to 8003 in a number of places:

UserServer_Config.xml: "default_grid_server" - For the URM server. 
MessagingServer_Config.xml: "default_grid_server" - For the URM server.

On the URM server, save a copy of your existing OpenSim.Server.ini. Copy OpenSim.Server.ini.example to OpenSim.Server.ini. Edit it to reflect any changes you made in the previous version. Then edit the "ConnectionString" entry, appropriately, in the [GridService] section.

GridServer_Config.xml can be deleted from the URM server.

Bring up URM. Bring up regions.

==Moving the Grid Server to its own ROBUST shell ==

Alternatively, if you have a large grid, you may want to run the grid service in its own ROBUST shell. If so, do this:

* Copy OpenSim.GridServer.ini.example to your own copy
* Edit it and change it so that it uses your regular Database and the usual Grid Server port
* Start U, then start the grid server like this:
$ OpenSim.Server.exe -inifile=OpenSim.GridServer.ini -logfile=/some/path/to/some/file
* Start AI and M as usual
* Start your sims

If you keep the grid server listening to the port you had before you don't need to change any other configuration files except to update the GridCommon.ini in the config-include folder as listed in the new GridCommon.ini.example.

Serverless Grids

2009-09-30T16:12:54Z

Smxy: /* Step One: Install a DB server */

This tutorial explains how to set up a grid composed of several simulators, possibly running on different machines, by stitching standalones together, and without running extra servers (URM or others). The only other server you need besides OpenSim.exe (the simulator) is either a MySQL or MSSQL server -- the DB.

This hybrid architecture can be setup independent of whether you have Hypergrid enabled or not; however, for simplicity sake, the explanation here uses the pre-packaged configuration StandaloneHypergrid, because it already has all the right connectors enabled. For configurations of non-HG standalones, please ask on the IRC.

NOTE: this works with releases r10869 and above (as of Sep.28)

== Step One: Install a DB server ==

This tutorial does not explain how to do this, but you need a database server running in one of your machines. Please see elsewhere on this wiki, or search on the Web how to do that. You can either use MySQL or MSSQL; this tutorial assumes MySQL, but for MSSQL it's in all identical.

After installing a MySQL server, create an account called "opensim", and give all permissions to that account. For a grid spawning multiple machines, you need to set up this account so that it can access the DB server from other machines. Again, search elsewhere for how to do this, if you don't know.

Before you go any further, make sure this account is properly setup by logging to the DB server from all the machines where you plan to run simulators. If you can't login with the mysql client from those machines, using the opensim account you just created, OpenSim also won't be able to. So don't even attempt at proceeding to step two if this doesn't work.

== Step Two: OpenSim Configuration ==

For each OpenSim simulator instance do this.

As usual, copy OpenSim.ini.example to your own copy of OpenSim.ini. Make whatever changes you usually make to work in HG standalone. You can use your prior copy of OpenSim.ini. Then make the following changes:

#Search for "userDatabase_plugin". Set it to userDatabase_plugin = "OpenSim.Data.MySQL.dll"
#Search for "user_source". Set it to user_source = "Data Source=XXX;Database=opensim;User ID=opensim;Password=YYY;" where XXX = localhost or the name of the machine where you have your MySQL server, if different from the local machine YYY = the password of the opensim account you have created
#In the [Architecture] section, make sure this one is choosen: Include-HGStandalone = "config-include/StandaloneHypergrid.ini" 

Copy config-include/StandaloneCommon.ini.example to config-include/StandaloneCommon.ini, and make the following changes/settings: 

#In the [DatabaseService] section, choose MySql instead of the default SQLite: StorageProvider = "OpenSim.Data.MySQL.dll" ConnectionString = "Data Source=XXX;Database=opensim;User ID=opensim;Password=YYY;" (see XXX and YYY above) 
#In the [GridService] section, choose the MySql option instead of the default one: StorageProvider = "OpenSim.Data.MySQL.dll:MySqlRegionData" ConnectionString = "Data Source=XXX;Database=opensim;User ID=opensim;Password=YYY;" 

== Step Three: Region Configuration ==

For each OpenSim simulator instance, set up region files as you usually do. Make sure that no two regions are on the same coordinates. If you want the differerent simulators to form a larger contiguous space, place the regions in such a way that they are neighbours.

== Step Four: Start Up the Simulators ==

As the title says, start the simulators. You may want to let each one finish starting up before starting the next one. For different simulators with neighbouring regions, you should see console messages pertaining to "HelloNeighbour", which is an indication that the simulators are finding each other.

== Step Five: Login ==

Your login uri is the normal uri for standalones. That is, http://<one of your simulators>:<http port>

 

And voila! Insta-scalability without servers.

== Notes: ==

*Instant messaging does not yet work on these grids. It will soon.

ROBUST

2009-09-30T04:57:04Z

Smxy: /* An Example Conversion From UGRM To URM */

==Redesigned OpenSim Basic Universal Server Technology (R.O.B.U.S.T.)==
===Concepts===
R.O.B.U.S.T. (ROBUST) leverages the system of in and out connectors and services that was developed for the Hypergrid and OpenSim. It replaces OGS1 with a modular architecture that can be easily extended using core and 3rd party modules.

R.O.B.U.S.T. (ROBUST) is a flexible server shell that can load the same modules already used by regions. This allows for nearly 100% code reusability and great flexibility.

The R.O.B.U.S.T. (ROBUST) server loads "in" connectors as specified in the configuration file. These connectors then load the required processing and storage modules and/or "out" connectors. Through this architecture, each R.O.B.U.S.T. server can run any or all grid services, and/or act as a proxy for grid services.

===Configuration===
The server reads a configuration file at startup, which defaults to the name of the assembly with .ini appended. The default name for the R.O.B.U.S.T. (ROBUST) server is OpenSim.Server.exe, therefore the default configuration file is OpenSim.Server.ini. An OpenSim.Server.ini.example file is provided with the OpenSim kit.

; * The startup section lists all the connectors to start up in this server
; * instance. This may be only one, or it may be the entire server suite.
; * Multiple connectors should be seaprated by commas.
; *
; * These are the IN connectors the server uses, the in connectors
; * read this config file and load the needed OUT and database connectors
; *
[Startup]
ServiceConnectors = "OpenSim.Server.Handlers.dll:AssetServiceConnector,OpenSim.Server.Handlers.dll:InventoryServiceInConnector"

; * This is common for all services, it's the network setup for the entire
; * server instance
; *
[Network]
port = 8003

; * As an example, the below configuration precisely mimicks the legacy
; * asset server. It is read by the asset IN connector (defined above)
; * and it then loads the OUT connector (a local database module). That,
; * in turn, reads the asset loader and database connection information
; *
[AssetService]
LocalServiceModule = "OpenSim.Services.AssetService.dll:AssetService"
DefaultAssetLoader = "OpenSim.Framework.AssetLoader.Filesystem.dll"
AssetLoaderArgs = "assets/AssetSets.xml"
StorageProvider = "OpenSim.Data.MySQL.dll"
ConnectionString = "Data Source=localhost;Database=grid;User ID=grid;Password=grid;"

; * This configuration loads the inventory server modules. It duplicates
; * the function of the legacy inventory server
; *
[InventoryService]
LocalServiceModule = "OpenSim.Services.InventoryService.dll:InventoryService"
UserServerURI = "http://127.0.0.1:8002"
SessionAuthentication = "false"
StorageProvider = "OpenSim.Data.MySQL.dll"
ConnectionString = "Data Source=localhost;Database=grid;User ID=grid;Password=grid;"

===Command Line Arguments===
*-inifile
:Specify the location of the .ini file to read instead of the default
*-console
:Specify console type, one of basic, local or rest
*-logfile
:Specify the logfile this server will log to
*-prompt
:Override the server prompt

==Configuration File==
===Section [Startup]===
*ServiceConnectors
:Comma separated list of service IN connectors. The format of each entry is <dllname>:<classname>. If a dll contains only one suitable class, the class name can be omitted.
*Prompt
:Override the server prompt
*Console
:Specify console type, one of basic, local or rest
*Logfile
:Specify the logfile this server will log to

===Section [Network]===
*Port
:Set the network port to listen on. All services will run on this port.

==Connector Configurations==
These configurations are provided by the connector modules and are not an integral part of the R.O.B.U.S.T. server. Documentation to all possible options can be found in the documentation of the connector. This manual only lists the options present in the sample configuration file.

===Section [AssetService]===
* LocalServiceModule [Connector option]
:A module specification (<dll>:<class>) that provides the services for this connector
* DefaultAssetLoader [Service option]
:A dll containing the asset loader to use for loading the default asset set
* AssetLoaderArgs [Service option]
:Path to load assets from (for the file system asset loader)
* StorageProvider [Service option]
:Dll containing the database provider code
* ConnectionString [Service option]
:Connection string to be passed to the database provider

===Section [InventoryService]===
* LocalServiceModule [Connector option]
:A module specification (<dll>:<class>) that provides the services for this connector
* UserServerURI [Connector option]
:URI to reach the user server at
* SessionAuthentication [Connector option]
:Authenticate inventory sessions (default false!)
* StorageProvider [Service option]
:Dll containing the database provider code
* ConnectionString [Service option]
:Connection string to be passed to the database provider

Additional connectors may need additional sections to be added.

==An Example Conversion From UGAIM To UGRM==

Converting from UGAIM to UGRM:

Kudos to diva and Melanie_t for helping and tolerating me (smxy).

My initial setup:

Full HG-enabled, Internet-accessible, Grid Mode system, using MySQL and split over two servers.

UGAIM and MySQL 5.0 run in two separate 32-bit CentOS 5.3 Xen VMs on a 64-bit CentOS 5.3 system. 
Each region runs in its own instance of OpenSim.exe on a 32-bit Windows XP SP3 Home system. 
OSWI runs on the Windows system too.

Bring down the regions. Bring down UGAIM.

Then, the port for the inventory server needs to be changed from 8004 to 8003 in a number of places:

OpenSim.ini: "inventory_server_url" - For all regions and the UGRM server. 
GridCommon.ini: "InventoryServerURI" - For all regions and the UGRM server. 
UserServer_Config.xml: "default_inventory_server" - For the UGRM server.

In the MySQL database, in the "users" table, the userInventoryURI field needs to be updated for all users.

In OSWI's config file, update "$userInventoryURI".

AssetServer_Config.xml and InventoryServer_Config.xml can be deleted from the UGRM server.

On the UGRM server, copy OpenSim.Server.ini.example to OpenSim.Server.ini and edit it, changing the "ConnectionString" entries appropriately, in the [AssetService] and [InventoryService] sections.

Bring up UGRM. Bring up regions.

Semi-unrelated Note: According to Melanie_t, any of the UGRM servers can be restarted independently,
without needing to restart the other three. However, if you restart the UserServer, you must issue
the command "register" (without the quotes) at the MessagingServer console, afterwards.

==An Example Conversion From UGRM To URM==

Converting from UGRM to URM:

This is a continuation of my "UGAIM to UGRM" example above. Eventually, I will merge the two examples.

Bring down the regions. Bring down UGRM.

Then, the port for the grid server needs to be changed from 8001 to 8003 in a number of places:

OpenSim.ini: "grid_server_url" - For all regions and the URM server. 
UserServer_Config.xml: "default_grid_server" - For the URM server. 
MessagingServer_Config.xml: "default_grid_server" - For the URM server.

On the URM server, save a copy of your existing OpenSim.Server.ini. Copy OpenSim.Server.ini.example to OpenSim.Server.ini. Edit it to reflect any changes you made in the previous version. Then edit the "ConnectionString" entry, appropriately, in the [GridService] section.

GridServer_Config.xml can be deleted from the URM server.

Bring up URM. Bring up regions.

==Moving the Grid Server to its own ROBUST shell ==

Alternatively, if you have a large grid, you may want to run the grid service in its own ROBUST shell. If so, do this:

* Copy OpenSim.GridServer.ini.example to your own copy
* Edit it and change it so that it uses your regular Database and the usual Grid Server port
* Start U, then start the grid server like this:
$ OpenSim.Server.exe -inifile=OpenSim.GridServer.ini -logfile=/some/path/to/some/file
* Start AI and M as usual
* Start your sims

If you keep the grid server listening to the port you had before you don't need to change any other configuration files.

ROBUST

2009-09-30T03:55:05Z

Smxy: /* An Example Conversion From UGAIM To UGRM */

==Redesigned OpenSim Basic Universal Server Technology (R.O.B.U.S.T.)==
===Concepts===
R.O.B.U.S.T. (ROBUST) leverages the system of in and out connectors and services that was developed for the Hypergrid and OpenSim. It replaces OGS1 with a modular architecture that can be easily extended using core and 3rd party modules.

R.O.B.U.S.T. (ROBUST) is a flexible server shell that can load the same modules already used by regions. This allows for nearly 100% code reusability and great flexibility.

The R.O.B.U.S.T. (ROBUST) server loads "in" connectors as specified in the configuration file. These connectors then load the required processing and storage modules and/or "out" connectors. Through this architecture, each R.O.B.U.S.T. server can run any or all grid services, and/or act as a proxy for grid services.

===Configuration===
The server reads a configuration file at startup, which defaults to the name of the assembly with .ini appended. The default name for the R.O.B.U.S.T. (ROBUST) server is OpenSim.Server.exe, therefore the default configuration file is OpenSim.Server.ini. An OpenSim.Server.ini.example file is provided with the OpenSim kit.

; * The startup section lists all the connectors to start up in this server
; * instance. This may be only one, or it may be the entire server suite.
; * Multiple connectors should be seaprated by commas.
; *
; * These are the IN connectors the server uses, the in connectors
; * read this config file and load the needed OUT and database connectors
; *
[Startup]
ServiceConnectors = "OpenSim.Server.Handlers.dll:AssetServiceConnector,OpenSim.Server.Handlers.dll:InventoryServiceInConnector"

; * This is common for all services, it's the network setup for the entire
; * server instance
; *
[Network]
port = 8003

; * As an example, the below configuration precisely mimicks the legacy
; * asset server. It is read by the asset IN connector (defined above)
; * and it then loads the OUT connector (a local database module). That,
; * in turn, reads the asset loader and database connection information
; *
[AssetService]
LocalServiceModule = "OpenSim.Services.AssetService.dll:AssetService"
DefaultAssetLoader = "OpenSim.Framework.AssetLoader.Filesystem.dll"
AssetLoaderArgs = "assets/AssetSets.xml"
StorageProvider = "OpenSim.Data.MySQL.dll"
ConnectionString = "Data Source=localhost;Database=grid;User ID=grid;Password=grid;"

; * This configuration loads the inventory server modules. It duplicates
; * the function of the legacy inventory server
; *
[InventoryService]
LocalServiceModule = "OpenSim.Services.InventoryService.dll:InventoryService"
UserServerURI = "http://127.0.0.1:8002"
SessionAuthentication = "false"
StorageProvider = "OpenSim.Data.MySQL.dll"
ConnectionString = "Data Source=localhost;Database=grid;User ID=grid;Password=grid;"

===Command Line Arguments===
*-inifile
:Specify the location of the .ini file to read instead of the default
*-console
:Specify console type, one of basic, local or rest
*-logfile
:Specify the logfile this server will log to
*-prompt
:Override the server prompt

==Configuration File==
===Section [Startup]===
*ServiceConnectors
:Comma separated list of service IN connectors. The format of each entry is <dllname>:<classname>. If a dll contains only one suitable class, the class name can be omitted.
*Prompt
:Override the server prompt
*Console
:Specify console type, one of basic, local or rest
*Logfile
:Specify the logfile this server will log to

===Section [Network]===
*Port
:Set the network port to listen on. All services will run on this port.

==Connector Configurations==
These configurations are provided by the connector modules and are not an integral part of the R.O.B.U.S.T. server. Documentation to all possible options can be found in the documentation of the connector. This manual only lists the options present in the sample configuration file.

===Section [AssetService]===
* LocalServiceModule [Connector option]
:A module specification (<dll>:<class>) that provides the services for this connector
* DefaultAssetLoader [Service option]
:A dll containing the asset loader to use for loading the default asset set
* AssetLoaderArgs [Service option]
:Path to load assets from (for the file system asset loader)
* StorageProvider [Service option]
:Dll containing the database provider code
* ConnectionString [Service option]
:Connection string to be passed to the database provider

===Section [InventoryService]===
* LocalServiceModule [Connector option]
:A module specification (<dll>:<class>) that provides the services for this connector
* UserServerURI [Connector option]
:URI to reach the user server at
* SessionAuthentication [Connector option]
:Authenticate inventory sessions (default false!)
* StorageProvider [Service option]
:Dll containing the database provider code
* ConnectionString [Service option]
:Connection string to be passed to the database provider

Additional connectors may need additional sections to be added.

==An Example Conversion From UGAIM To UGRM==

Converting from UGAIM to UGRM:

Kudos to diva and Melanie_t for helping and tolerating me (smxy).

My initial setup:

Full HG-enabled, Internet-accessible, Grid Mode system, using MySQL and split over two servers.

UGAIM and MySQL 5.0 run in two separate 32-bit CentOS 5.3 Xen VMs on a 64-bit CentOS 5.3 system. 
Each region runs in its own instance of OpenSim.exe on a 32-bit Windows XP SP3 Home system. 
OSWI runs on the Windows system too.

Bring down the regions. Bring down UGAIM.

Then, the port for the inventory server needs to be changed from 8004 to 8003 in a number of places:

OpenSim.ini: "inventory_server_url" - For all regions and the UGRM server. 
GridCommon.ini: "InventoryServerURI" - For all regions and the UGRM server. 
UserServer_Config.xml: "default_inventory_server" - For the UGRM server.

In the MySQL database, in the "users" table, the userInventoryURI field needs to be updated for all users.

In OSWI's config file, update "$userInventoryURI".

AssetServer_Config.xml and InventoryServer_Config.xml can be deleted from the UGRM server.

On the UGRM server, copy OpenSim.Server.ini.example to OpenSim.Server.ini and edit it, changing the "ConnectionString" entries appropriately, in the [AssetService] and [InventoryService] sections.

Bring up UGRM. Bring up regions.

Semi-unrelated Note: According to Melanie_t, any of the UGRM servers can be restarted independently,
without needing to restart the other three. However, if you restart the UserServer, you must issue
the command "register" (without the quotes) at the MessagingServer console, afterwards.

==An Example Conversion From UGRM To URM==

Converting from UGRM to URM:

This is a continuation of my "UGAIM to UGRM" example above. Eventually, I will merge the two examples.

Bring down the regions. Bring down UGRM.

Then, the port for the grid server needs to be changed from 8001 to 8003 in a number of places:

OpenSim.ini: "grid_server_url" - For all regions and the URM server. 
UserServer_Config.xml: "default_grid_server" - For the URM server. 
MessagingServer_Config.xml: "default_grid_server" - For the URM server.

On the URM server, save a copy of OpenSim.Server.ini. Copy OpenSim.Server.ini.example to OpenSim.Server.ini. Edit it to reflect any changes you made in the previous version. Then edit the "ConnectionString" entry, appropriately, in the [GridService] section.

GridServer_Config.xml can be deleted from the URM server.

Bring up URM. Bring up regions.

==Moving the Grid Server to its own ROBUST shell ==

Alternatively, if you have a large grid, you may want to run the grid service in its own ROBUST shell. If so, do this:

* Copy OpenSim.GridServer.ini.example to your own copy
* Edit it and change it so that it uses your regular Database and the usual Grid Server port
* Start U, then start the grid server like this:
$ OpenSim.Server.exe -inifile=OpenSim.GridServer.ini -logfile=/some/path/to/some/file
* Start AI and M as usual
* Start your sims

If you keep the grid server listening to the port you had before you don't need to change any other configuration files.

ROBUST

2009-09-30T03:45:13Z

Smxy: /* An Example Conversion From UGRM To URM */

==Redesigned OpenSim Basic Universal Server Technology (R.O.B.U.S.T.)==
===Concepts===
R.O.B.U.S.T. (ROBUST) leverages the system of in and out connectors and services that was developed for the Hypergrid and OpenSim. It replaces OGS1 with a modular architecture that can be easily extended using core and 3rd party modules.

R.O.B.U.S.T. (ROBUST) is a flexible server shell that can load the same modules already used by regions. This allows for nearly 100% code reusability and great flexibility.

The R.O.B.U.S.T. (ROBUST) server loads "in" connectors as specified in the configuration file. These connectors then load the required processing and storage modules and/or "out" connectors. Through this architecture, each R.O.B.U.S.T. server can run any or all grid services, and/or act as a proxy for grid services.

===Configuration===
The server reads a configuration file at startup, which defaults to the name of the assembly with .ini appended. The default name for the R.O.B.U.S.T. (ROBUST) server is OpenSim.Server.exe, therefore the default configuration file is OpenSim.Server.ini. An OpenSim.Server.ini.example file is provided with the OpenSim kit.

; * The startup section lists all the connectors to start up in this server
; * instance. This may be only one, or it may be the entire server suite.
; * Multiple connectors should be seaprated by commas.
; *
; * These are the IN connectors the server uses, the in connectors
; * read this config file and load the needed OUT and database connectors
; *
[Startup]
ServiceConnectors = "OpenSim.Server.Handlers.dll:AssetServiceConnector,OpenSim.Server.Handlers.dll:InventoryServiceInConnector"

; * This is common for all services, it's the network setup for the entire
; * server instance
; *
[Network]
port = 8003

; * As an example, the below configuration precisely mimicks the legacy
; * asset server. It is read by the asset IN connector (defined above)
; * and it then loads the OUT connector (a local database module). That,
; * in turn, reads the asset loader and database connection information
; *
[AssetService]
LocalServiceModule = "OpenSim.Services.AssetService.dll:AssetService"
DefaultAssetLoader = "OpenSim.Framework.AssetLoader.Filesystem.dll"
AssetLoaderArgs = "assets/AssetSets.xml"
StorageProvider = "OpenSim.Data.MySQL.dll"
ConnectionString = "Data Source=localhost;Database=grid;User ID=grid;Password=grid;"

; * This configuration loads the inventory server modules. It duplicates
; * the function of the legacy inventory server
; *
[InventoryService]
LocalServiceModule = "OpenSim.Services.InventoryService.dll:InventoryService"
UserServerURI = "http://127.0.0.1:8002"
SessionAuthentication = "false"
StorageProvider = "OpenSim.Data.MySQL.dll"
ConnectionString = "Data Source=localhost;Database=grid;User ID=grid;Password=grid;"

===Command Line Arguments===
*-inifile
:Specify the location of the .ini file to read instead of the default
*-console
:Specify console type, one of basic, local or rest
*-logfile
:Specify the logfile this server will log to
*-prompt
:Override the server prompt

==Configuration File==
===Section [Startup]===
*ServiceConnectors
:Comma separated list of service IN connectors. The format of each entry is <dllname>:<classname>. If a dll contains only one suitable class, the class name can be omitted.
*Prompt
:Override the server prompt
*Console
:Specify console type, one of basic, local or rest
*Logfile
:Specify the logfile this server will log to

===Section [Network]===
*Port
:Set the network port to listen on. All services will run on this port.

==Connector Configurations==
These configurations are provided by the connector modules and are not an integral part of the R.O.B.U.S.T. server. Documentation to all possible options can be found in the documentation of the connector. This manual only lists the options present in the sample configuration file.

===Section [AssetService]===
* LocalServiceModule [Connector option]
:A module specification (<dll>:<class>) that provides the services for this connector
* DefaultAssetLoader [Service option]
:A dll containing the asset loader to use for loading the default asset set
* AssetLoaderArgs [Service option]
:Path to load assets from (for the file system asset loader)
* StorageProvider [Service option]
:Dll containing the database provider code
* ConnectionString [Service option]
:Connection string to be passed to the database provider

===Section [InventoryService]===
* LocalServiceModule [Connector option]
:A module specification (<dll>:<class>) that provides the services for this connector
* UserServerURI [Connector option]
:URI to reach the user server at
* SessionAuthentication [Connector option]
:Authenticate inventory sessions (default false!)
* StorageProvider [Service option]
:Dll containing the database provider code
* ConnectionString [Service option]
:Connection string to be passed to the database provider

Additional connectors may need additional sections to be added.

==An Example Conversion From UGAIM To UGRM==

Converting from UGAIM to UGRM:

Kudos to diva and Melanie_t for helping and tolerating me (smxy).

My initial setup:

Full HG-enabled, Internet-accessible, Grid Mode system, using MySQL and split over two servers.

UGAIM and MySQL 5.0 run in separate 32-bit CentOS 5.3 Xen VMs on a 64-bit CentOS 5.3 system. 
Each region runs in its own instance of OpenSim.exe on a 32-bit Windows XP SP3 Home system. 
OSWI runs on the Windows system too.

Bring down the regions. Bring down UGAIM.

Then, the port for the inventory server needs to be changed from 8004 to 8003 in a number of places:

OpenSim.ini: "inventory_server_url" - For all regions and the UGRM server. 
GridCommon.ini: "InventoryServerURI" - For all regions and the UGRM server. 
UserServer_Config.xml: "default_inventory_server" - For the UGRM server.

In the MySQL database, in the "users" table, the userInventoryURI field needs to be updated for all users.

In OSWI's config file, update "$userInventoryURI".

AssetServer_Config.xml and InventoryServer_Config.xml can be deleted from the UGRM server.

On the UGRM server, copy OpenSim.Server.ini.example to OpenSim.Server.ini and edit it, changing the "ConnectionString" entries appropriately, in the [AssetService] and [InventoryService] sections.

Bring up UGRM. Bring up regions.

Semi-unrelated Note: According to Melanie_t, any of the UGRM servers can be restarted independently,
without needing to restart the other three. However, if you restart the UserServer, you must issue
the command "register" (without the quotes) at the MessagingServer console, afterwards.

==An Example Conversion From UGRM To URM==

Converting from UGRM to URM:

This is a continuation of my "UGAIM to UGRM" example above. Eventually, I will merge the two examples.

Bring down the regions. Bring down UGRM.

Then, the port for the grid server needs to be changed from 8001 to 8003 in a number of places:

OpenSim.ini: "grid_server_url" - For all regions and the URM server. 
UserServer_Config.xml: "default_grid_server" - For the URM server. 
MessagingServer_Config.xml: "default_grid_server" - For the URM server.

On the URM server, save a copy of OpenSim.Server.ini. Copy OpenSim.Server.ini.example to OpenSim.Server.ini. Edit it to reflect any changes you made in the previous version. Then edit the "ConnectionString" entry, appropriately, in the [GridService] section.

GridServer_Config.xml can be deleted from the URM server.

Bring up URM. Bring up regions.

==Moving the Grid Server to its own ROBUST shell ==

Alternatively, if you have a large grid, you may want to run the grid service in its own ROBUST shell. If so, do this:

* Copy OpenSim.GridServer.ini.example to your own copy
* Edit it and change it so that it uses your regular Database and the usual Grid Server port
* Start U, then start the grid server like this:
$ OpenSim.Server.exe -inifile=OpenSim.GridServer.ini -logfile=/some/path/to/some/file
* Start AI and M as usual
* Start your sims

If you keep the grid server listening to the port you had before you don't need to change any other configuration files.

ROBUST

2009-09-28T15:19:02Z

Smxy: /* An Example Conversion From UGRM To URM */

==Redesigned OpenSim Basic Universal Server Technology (R.O.B.U.S.T.)==
===Concepts===
R.O.B.U.S.T. (ROBUST) leverages the system of in and out connectors and services that was developed for the Hypergrid and OpenSim. It replaces OGS1 with a modular architecture that can be easily extended using core and 3rd party modules.

R.O.B.U.S.T. (ROBUST) is a flexible server shell that can load the same modules already used by regions. This allows for nearly 100% code reusability and great flexibility.

The R.O.B.U.S.T. (ROBUST) server loads "in" connectors as specified in the configuration file. These connectors then load the required processing and storage modules and/or "out" connectors. Through this architecture, each R.O.B.U.S.T. server can run any or all grid services, and/or act as a proxy for grid services.

===Configuration===
The server reads a configuration file at startup, which defaults to the name of the assembly with .ini appended. The default name for the R.O.B.U.S.T. (ROBUST) server is OpenSim.Server.exe, therefore the default configuration file is OpenSim.Server.ini. An OpenSim.Server.ini.example file is provided with the OpenSim kit.

; * The startup section lists all the connectors to start up in this server
; * instance. This may be only one, or it may be the entire server suite.
; * Multiple connectors should be seaprated by commas.
; *
; * These are the IN connectors the server uses, the in connectors
; * read this config file and load the needed OUT and database connectors
; *
[Startup]
ServiceConnectors = "OpenSim.Server.Handlers.dll:AssetServiceConnector,OpenSim.Server.Handlers.dll:InventoryServiceInConnector"

; * This is common for all services, it's the network setup for the entire
; * server instance
; *
[Network]
port = 8003

; * As an example, the below configuration precisely mimicks the legacy
; * asset server. It is read by the asset IN connector (defined above)
; * and it then loads the OUT connector (a local database module). That,
; * in turn, reads the asset loader and database connection information
; *
[AssetService]
LocalServiceModule = "OpenSim.Services.AssetService.dll:AssetService"
DefaultAssetLoader = "OpenSim.Framework.AssetLoader.Filesystem.dll"
AssetLoaderArgs = "assets/AssetSets.xml"
StorageProvider = "OpenSim.Data.MySQL.dll"
ConnectionString = "Data Source=localhost;Database=grid;User ID=grid;Password=grid;"

; * This configuration loads the inventory server modules. It duplicates
; * the function of the legacy inventory server
; *
[InventoryService]
LocalServiceModule = "OpenSim.Services.InventoryService.dll:InventoryService"
UserServerURI = "http://127.0.0.1:8002"
SessionAuthentication = "false"
StorageProvider = "OpenSim.Data.MySQL.dll"
ConnectionString = "Data Source=localhost;Database=grid;User ID=grid;Password=grid;"

===Command Line Arguments===
*-inifile
:Specify the location of the .ini file to read instead of the default
*-console
:Specify console type, one of basic, local or rest
*-logfile
:Specify the logfile this server will log to
*-prompt
:Override the server prompt

==Configuration File==
===Section [Startup]===
*ServiceConnectors
:Comma separated list of service IN connectors. The format of each entry is <dllname>:<classname>. If a dll contains only one suitable class, the class name can be omitted.
*Prompt
:Override the server prompt
*Console
:Specify console type, one of basic, local or rest
*Logfile
:Specify the logfile this server will log to

===Section [Network]===
*Port
:Set the network port to listen on. All services will run on this port.

==Connector Configurations==
These configurations are provided by the connector modules and are not an integral part of the R.O.B.U.S.T. server. Documentation to all possible options can be found in the documentation of the connector. This manual only lists the options present in the sample configuration file.

===Section [AssetService]===
* LocalServiceModule [Connector option]
:A module specification (<dll>:<class>) that provides the services for this connector
* DefaultAssetLoader [Service option]
:A dll containing the asset loader to use for loading the default asset set
* AssetLoaderArgs [Service option]
:Path to load assets from (for the file system asset loader)
* StorageProvider [Service option]
:Dll containing the database provider code
* ConnectionString [Service option]
:Connection string to be passed to the database provider

===Section [InventoryService]===
* LocalServiceModule [Connector option]
:A module specification (<dll>:<class>) that provides the services for this connector
* UserServerURI [Connector option]
:URI to reach the user server at
* SessionAuthentication [Connector option]
:Authenticate inventory sessions (default false!)
* StorageProvider [Service option]
:Dll containing the database provider code
* ConnectionString [Service option]
:Connection string to be passed to the database provider

Additional connectors may need additional sections to be added.

==Alternate Configuration Files==
To run R.O.B.U.S.T. as separate processes, emulatig the legacy servers, you can copy the server executables to the names of the legacy servers:
cp OpenSim.Server.exe OpenSim.Grid.AssetServer.exe
cp OpenSim.Server.exe.config OpenSim.Grid.AssetServer.exe.config
cp OpenSim.Server.ini OpenSim.Grid.AssetServer.ini

Then, modify OpenSim.Grid.AssetServer.ini to read:
[Startup]
ServiceConnectors = "OpenSim.Server.Handlers.dll:AssetServiceConnector"

[Network]
port = 8003

[AssetService]
LocalServiceModule = "OpenSim.Services.AssetService.dll:AssetService"
DefaultAssetLoader = "OpenSim.Framework.AssetLoader.Filesystem.dll"
AssetLoaderArgs = "assets/AssetSets.xml"
StorageProvider = "OpenSim.Data.MySQL.dll"
ConnectionString = "Data Source=localhost;Database=grid;User ID=grid;Password=grid;"

Now, when you run OpenSim.Grid.AssetServer.exe, it will act like the legacy asset server it replaces.

You can do the same for all other supported services.

This method is working fine as a replacement of the old Asset & Inventory servers, BUT : In the 2 following files :
OpenSim.Grid.AssetServer.exe.config
OpenSim.Grid.InventoryServer.exe.config

You have to update the log filename : from "OpenSim.log" to "OpenSim.Grid.AssetServer.log" & "'OpenSim.Grid.InventoryServer.log".

Just because there is a conflict accessing the logfile ( write ) ... So, if you don't do that modification, your OpenSim.exe won't start. ( Linux / Mono 2.4.2 )

==An Example Conversion From UGAIM To UGRM==

Converting from UGAIM to UGRM:

Kudos to diva and Melanie_t for helping and tolerating me (smxy).

My initial setup:

Full HG-enabled, Internet-accessible, Grid Mode system, using MySQL and split over two servers.

UGAIM and MySQL 5.0 run in separate 32-bit CentOS 5.3 Xen VMs on a 64-bit CentOS 5.3 system. 
Each region runs in its own instance of OpenSim.exe on a 32-bit Windows XP SP3 Home system. 
OSWI runs on the Windows system too.

Bring down the regions. Bring down UGAIM.

Then, the port for the inventory server needs to be changed from 8004 to 8003 in a number of places:

OpenSim.ini: "inventory_server_url" - For all regions and the UGRM server. 
GridCommon.ini: "InventoryServerURI" - For all regions and the UGRM server. 
UserServer_Config.xml: "default_inventory_server" - For the UGRM server.

In the MySQL database, in the "users" table, the userInventoryURI field needs to be updated for all users.

In OSWI's config file, update "$userInventoryURI".

AssetServer_Config.xml and InventoryServer_Config.xml can be deleted from the UGRM server.

On the UGRM server, copy OpenSim.Server.ini.example to OpenSim.Server.ini and edit it, changing the "ConnectionString" entries appropriately, in the [AssetService] and [InventoryService] sections.

Bring up UGRM. Bring up regions.

Semi-unrelated Note: According to Melanie_t, any of the UGRM servers can be restarted independently,
without needing to restart the other three. However, if you restart the UserServer, you must issue
the command "register" (without the quotes) at the MessagingServer console, afterwards.

==An Example Conversion From UGRM To URM==

'''Note: The code to do this is not in trunk yet, but is expected to be there very soon. I'll remove this note as soon as it hits trunk.'''

Converting from UGRM to URM:

This is a continuation of my "UGAIM to UGRM" example above. Eventually, I will merge the two examples.

Bring down the regions. Bring down UGRM.

Then, the port for the grid server needs to be changed from 8001 to 8003 in a number of places:

OpenSim.ini: "grid_server_url" - For all regions and the URM server. 
UserServer_Config.xml: "default_grid_server" - For the URM server. 
MessagingServer_Config.xml: "default_grid_server" - For the URM server.

On the URM server, save a copy of OpenSim.Server.ini. Copy OpenSim.Server.ini.example to OpenSim.Server.ini. Edit it to reflect any changes you made in the previous version. Then edit the "ConnectionString" entry, appropriately, in the [GridService] section.

GridServer_Config.xml can be deleted from the URM server.

Bring up URM. Bring up regions.

==Moving the Grid Server to ROBUST==

* Copy OpenSim.GridServer.ini.example to your own copy
* Edit it and change it so that it uses your regular Database and the usual Grid Server port
* Start U, then start the grid server like this:
$ OpenSim.Server.exe -inifile=OpenSim.GridServer.ini -logfile=/some/path/to/some/file
* Start AI and M as usual
* Start your sims

ROBUST

2009-09-28T15:13:09Z

Smxy: /* An Example Conversion From UGAIM To UGRM */

==Redesigned OpenSim Basic Universal Server Technology (R.O.B.U.S.T.)==
===Concepts===
R.O.B.U.S.T. (ROBUST) leverages the system of in and out connectors and services that was developed for the Hypergrid and OpenSim. It replaces OGS1 with a modular architecture that can be easily extended using core and 3rd party modules.

R.O.B.U.S.T. (ROBUST) is a flexible server shell that can load the same modules already used by regions. This allows for nearly 100% code reusability and great flexibility.

The R.O.B.U.S.T. (ROBUST) server loads "in" connectors as specified in the configuration file. These connectors then load the required processing and storage modules and/or "out" connectors. Through this architecture, each R.O.B.U.S.T. server can run any or all grid services, and/or act as a proxy for grid services.

===Configuration===
The server reads a configuration file at startup, which defaults to the name of the assembly with .ini appended. The default name for the R.O.B.U.S.T. (ROBUST) server is OpenSim.Server.exe, therefore the default configuration file is OpenSim.Server.ini. An OpenSim.Server.ini.example file is provided with the OpenSim kit.

; * The startup section lists all the connectors to start up in this server
; * instance. This may be only one, or it may be the entire server suite.
; * Multiple connectors should be seaprated by commas.
; *
; * These are the IN connectors the server uses, the in connectors
; * read this config file and load the needed OUT and database connectors
; *
[Startup]
ServiceConnectors = "OpenSim.Server.Handlers.dll:AssetServiceConnector,OpenSim.Server.Handlers.dll:InventoryServiceInConnector"

; * This is common for all services, it's the network setup for the entire
; * server instance
; *
[Network]
port = 8003

; * As an example, the below configuration precisely mimicks the legacy
; * asset server. It is read by the asset IN connector (defined above)
; * and it then loads the OUT connector (a local database module). That,
; * in turn, reads the asset loader and database connection information
; *
[AssetService]
LocalServiceModule = "OpenSim.Services.AssetService.dll:AssetService"
DefaultAssetLoader = "OpenSim.Framework.AssetLoader.Filesystem.dll"
AssetLoaderArgs = "assets/AssetSets.xml"
StorageProvider = "OpenSim.Data.MySQL.dll"
ConnectionString = "Data Source=localhost;Database=grid;User ID=grid;Password=grid;"

; * This configuration loads the inventory server modules. It duplicates
; * the function of the legacy inventory server
; *
[InventoryService]
LocalServiceModule = "OpenSim.Services.InventoryService.dll:InventoryService"
UserServerURI = "http://127.0.0.1:8002"
SessionAuthentication = "false"
StorageProvider = "OpenSim.Data.MySQL.dll"
ConnectionString = "Data Source=localhost;Database=grid;User ID=grid;Password=grid;"

===Command Line Arguments===
*-inifile
:Specify the location of the .ini file to read instead of the default
*-console
:Specify console type, one of basic, local or rest
*-logfile
:Specify the logfile this server will log to
*-prompt
:Override the server prompt

==Configuration File==
===Section [Startup]===
*ServiceConnectors
:Comma separated list of service IN connectors. The format of each entry is <dllname>:<classname>. If a dll contains only one suitable class, the class name can be omitted.
*Prompt
:Override the server prompt
*Console
:Specify console type, one of basic, local or rest
*Logfile
:Specify the logfile this server will log to

===Section [Network]===
*Port
:Set the network port to listen on. All services will run on this port.

==Connector Configurations==
These configurations are provided by the connector modules and are not an integral part of the R.O.B.U.S.T. server. Documentation to all possible options can be found in the documentation of the connector. This manual only lists the options present in the sample configuration file.

===Section [AssetService]===
* LocalServiceModule [Connector option]
:A module specification (<dll>:<class>) that provides the services for this connector
* DefaultAssetLoader [Service option]
:A dll containing the asset loader to use for loading the default asset set
* AssetLoaderArgs [Service option]
:Path to load assets from (for the file system asset loader)
* StorageProvider [Service option]
:Dll containing the database provider code
* ConnectionString [Service option]
:Connection string to be passed to the database provider

===Section [InventoryService]===
* LocalServiceModule [Connector option]
:A module specification (<dll>:<class>) that provides the services for this connector
* UserServerURI [Connector option]
:URI to reach the user server at
* SessionAuthentication [Connector option]
:Authenticate inventory sessions (default false!)
* StorageProvider [Service option]
:Dll containing the database provider code
* ConnectionString [Service option]
:Connection string to be passed to the database provider

Additional connectors may need additional sections to be added.

==Alternate Configuration Files==
To run R.O.B.U.S.T. as separate processes, emulatig the legacy servers, you can copy the server executables to the names of the legacy servers:
cp OpenSim.Server.exe OpenSim.Grid.AssetServer.exe
cp OpenSim.Server.exe.config OpenSim.Grid.AssetServer.exe.config
cp OpenSim.Server.ini OpenSim.Grid.AssetServer.ini

Then, modify OpenSim.Grid.AssetServer.ini to read:
[Startup]
ServiceConnectors = "OpenSim.Server.Handlers.dll:AssetServiceConnector"

[Network]
port = 8003

[AssetService]
LocalServiceModule = "OpenSim.Services.AssetService.dll:AssetService"
DefaultAssetLoader = "OpenSim.Framework.AssetLoader.Filesystem.dll"
AssetLoaderArgs = "assets/AssetSets.xml"
StorageProvider = "OpenSim.Data.MySQL.dll"
ConnectionString = "Data Source=localhost;Database=grid;User ID=grid;Password=grid;"

Now, when you run OpenSim.Grid.AssetServer.exe, it will act like the legacy asset server it replaces.

You can do the same for all other supported services.

This method is working fine as a replacement of the old Asset & Inventory servers, BUT : In the 2 following files :
OpenSim.Grid.AssetServer.exe.config
OpenSim.Grid.InventoryServer.exe.config

You have to update the log filename : from "OpenSim.log" to "OpenSim.Grid.AssetServer.log" & "'OpenSim.Grid.InventoryServer.log".

Just because there is a conflict accessing the logfile ( write ) ... So, if you don't do that modification, your OpenSim.exe won't start. ( Linux / Mono 2.4.2 )

==An Example Conversion From UGAIM To UGRM==

Converting from UGAIM to UGRM:

Kudos to diva and Melanie_t for helping and tolerating me (smxy).

My initial setup:

Full HG-enabled, Internet-accessible, Grid Mode system, using MySQL and split over two servers.

UGAIM and MySQL 5.0 run in separate 32-bit CentOS 5.3 Xen VMs on a 64-bit CentOS 5.3 system. 
Each region runs in its own instance of OpenSim.exe on a 32-bit Windows XP SP3 Home system. 
OSWI runs on the Windows system too.

Bring down the regions. Bring down UGAIM.

Then, the port for the inventory server needs to be changed from 8004 to 8003 in a number of places:

OpenSim.ini: "inventory_server_url" - For all regions and the UGRM server. 
GridCommon.ini: "InventoryServerURI" - For all regions and the UGRM server. 
UserServer_Config.xml: "default_inventory_server" - For the UGRM server.

In the MySQL database, in the "users" table, the userInventoryURI field needs to be updated for all users.

In OSWI's config file, update "$userInventoryURI".

AssetServer_Config.xml and InventoryServer_Config.xml can be deleted from the UGRM server.

On the UGRM server, copy OpenSim.Server.ini.example to OpenSim.Server.ini and edit it, changing the "ConnectionString" entries appropriately, in the [AssetService] and [InventoryService] sections.

Bring up UGRM. Bring up regions.

Semi-unrelated Note: According to Melanie_t, any of the UGRM servers can be restarted independently,
without needing to restart the other three. However, if you restart the UserServer, you must issue
the command "register" (without the quotes) at the MessagingServer console, afterwards.

==An Example Conversion From UGRM To URM==

'''Note: The code to do this is not in trunk yet, but is expected to be there very soon. I'll remove this note as soon as it hits trunk.'''

Converting from UGRM to URM:

This is a continuation of my example above. Eventually, I will merge the two examples.

Bring down the regions. Bring down UGRM.

Then, the port for the grid server needs to be changed from 8001 to 8003 in a number of places:

OpenSim.ini: "grid_server_url" - For all regions and the URM server. 
UserServer_Config.xml: "default_grid_server" - For the URM server. 
MessagingServer_Config.xml: "default_grid_server" - For the URM server.

On the URM server, save a copy of OpenSim.Server.ini. Copy OpenSim.Server.ini.example to OpenSim.Server.ini. Edit it to reflect any changes you made in the previous version. Then edit the "ConnectionString" entry, appropriately, in the [GridService] section.

GridServer_Config.xml can be deleted from the URM server.

Bring up URM. Bring up regions.

==Moving the Grid Server to ROBUST==

* Copy OpenSim.GridServer.ini.example to your own copy
* Edit it and change it so that it uses your regular Database and the usual Grid Server port
* Start U, then start the grid server like this:
$ OpenSim.Server.exe -inifile=OpenSim.GridServer.ini -logfile=/some/path/to/some/file
* Start AI and M as usual
* Start your sims

ROBUST

2009-09-28T14:10:17Z

Smxy:

==Redesigned OpenSim Basic Universal Server Technology (R.O.B.U.S.T.)==
===Concepts===
R.O.B.U.S.T. (ROBUST) leverages the system of in and out connectors and services that was developed for the Hypergrid and OpenSim. It replaces OGS1 with a modular architecture that can be easily extended using core and 3rd party modules.

R.O.B.U.S.T. (ROBUST) is a flexible server shell that can load the same modules already used by regions. This allows for nearly 100% code reusability and great flexibility.

The R.O.B.U.S.T. (ROBUST) server loads "in" connectors as specified in the configuration file. These connectors then load the required processing and storage modules and/or "out" connectors. Through this architecture, each R.O.B.U.S.T. server can run any or all grid services, and/or act as a proxy for grid services.

===Configuration===
The server reads a configuration file at startup, which defaults to the name of the assembly with .ini appended. The default name for the R.O.B.U.S.T. (ROBUST) server is OpenSim.Server.exe, therefore the default configuration file is OpenSim.Server.ini. An OpenSim.Server.ini.example file is provided with the OpenSim kit.

; * The startup section lists all the connectors to start up in this server
; * instance. This may be only one, or it may be the entire server suite.
; * Multiple connectors should be seaprated by commas.
; *
; * These are the IN connectors the server uses, the in connectors
; * read this config file and load the needed OUT and database connectors
; *
[Startup]
ServiceConnectors = "OpenSim.Server.Handlers.dll:AssetServiceConnector,OpenSim.Server.Handlers.dll:InventoryServiceInConnector"

; * This is common for all services, it's the network setup for the entire
; * server instance
; *
[Network]
port = 8003

; * As an example, the below configuration precisely mimicks the legacy
; * asset server. It is read by the asset IN connector (defined above)
; * and it then loads the OUT connector (a local database module). That,
; * in turn, reads the asset loader and database connection information
; *
[AssetService]
LocalServiceModule = "OpenSim.Services.AssetService.dll:AssetService"
DefaultAssetLoader = "OpenSim.Framework.AssetLoader.Filesystem.dll"
AssetLoaderArgs = "assets/AssetSets.xml"
StorageProvider = "OpenSim.Data.MySQL.dll"
ConnectionString = "Data Source=localhost;Database=grid;User ID=grid;Password=grid;"

; * This configuration loads the inventory server modules. It duplicates
; * the function of the legacy inventory server
; *
[InventoryService]
LocalServiceModule = "OpenSim.Services.InventoryService.dll:InventoryService"
UserServerURI = "http://127.0.0.1:8002"
SessionAuthentication = "false"
StorageProvider = "OpenSim.Data.MySQL.dll"
ConnectionString = "Data Source=localhost;Database=grid;User ID=grid;Password=grid;"

===Command Line Arguments===
*-inifile
:Specify the location of the .ini file to read instead of the default
*-console
:Specify console type, one of basic, local or rest
*-logfile
:Specify the logfile this server will log to
*-prompt
:Override the server prompt

==Configuration File==
===Section [Startup]===
*ServiceConnectors
:Comma separated list of service IN connectors. The format of each entry is <dllname>:<classname>. If a dll contains only one suitable class, the class name can be omitted.
*Prompt
:Override the server prompt
*Console
:Specify console type, one of basic, local or rest
*Logfile
:Specify the logfile this server will log to

===Section [Network]===
*Port
:Set the network port to listen on. All services will run on this port.

==Connector Configurations==
These configurations are provided by the connector modules and are not an integral part of the R.O.B.U.S.T. server. Documentation to all possible options can be found in the documentation of the connector. This manual only lists the options present in the sample configuration file.

===Section [AssetService]===
* LocalServiceModule [Connector option]
:A module specification (<dll>:<class>) that provides the services for this connector
* DefaultAssetLoader [Service option]
:A dll containing the asset loader to use for loading the default asset set
* AssetLoaderArgs [Service option]
:Path to load assets from (for the file system asset loader)
* StorageProvider [Service option]
:Dll containing the database provider code
* ConnectionString [Service option]
:Connection string to be passed to the database provider

===Section [InventoryService]===
* LocalServiceModule [Connector option]
:A module specification (<dll>:<class>) that provides the services for this connector
* UserServerURI [Connector option]
:URI to reach the user server at
* SessionAuthentication [Connector option]
:Authenticate inventory sessions (default false!)
* StorageProvider [Service option]
:Dll containing the database provider code
* ConnectionString [Service option]
:Connection string to be passed to the database provider

Additional connectors may need additional sections to be added.

==Alternate Configuration Files==
To run R.O.B.U.S.T. as separate processes, emulatig the legacy servers, you can copy the server executables to the names of the legacy servers:
cp OpenSim.Server.exe OpenSim.Grid.AssetServer.exe
cp OpenSim.Server.exe.config OpenSim.Grid.AssetServer.exe.config
cp OpenSim.Server.ini OpenSim.Grid.AssetServer.ini

Then, modify OpenSim.Grid.AssetServer.ini to read:
[Startup]
ServiceConnectors = "OpenSim.Server.Handlers.dll:AssetServiceConnector"

[Network]
port = 8003

[AssetService]
LocalServiceModule = "OpenSim.Services.AssetService.dll:AssetService"
DefaultAssetLoader = "OpenSim.Framework.AssetLoader.Filesystem.dll"
AssetLoaderArgs = "assets/AssetSets.xml"
StorageProvider = "OpenSim.Data.MySQL.dll"
ConnectionString = "Data Source=localhost;Database=grid;User ID=grid;Password=grid;"

Now, when you run OpenSim.Grid.AssetServer.exe, it will act like the legacy asset server it replaces.

You can do the same for all other supported services.

This method is working fine as a replacement of the old Asset & Inventory servers, BUT : In the 2 following files :
OpenSim.Grid.AssetServer.exe.config
OpenSim.Grid.InventoryServer.exe.config

You have to update the log filename : from "OpenSim.log" to "OpenSim.Grid.AssetServer.log" & "'OpenSim.Grid.InventoryServer.log".

Just because there is a conflict accessing the logfile ( write ) ... So, if you don't do that modification, your OpenSim.exe won't start. ( Linux / Mono 2.4.2 )

==An Example Conversion From UGAIM To UGRM==

Converting from UGAIM to UGRM:

Kudos to diva and Melanie_t for helping and tolerating me (smxy).

My initial setup:

Full HG-enabled, Internet-accessible, Grid Mode system, using MySQL and split over two servers.

UGAIM and MySQL 5.0 run in separate 32-bit CentOS 5.3 Xen VMs on a 64-bit CentOS 5.3 system. 
Each region runs in its own instance of OpenSim.exe on a 32-bit Windows XP SP3 Home system. 
OSWI runs on the Windows system too.

Bring down the regions. Bring down UGAIM.

Then, the port for the inventory server needs to be changed from 8004 to 8003 in a number of places:

OpenSim.ini: "inventory_server_url" - For all regions and the UGRM server. 
GridCommon.ini: "InventoryServerURI" - For all regions and the UGRM server. 
UserServer_Config.xml: "default_inventory_server" - For the UGRM server.

In the MySQL database, in the "users" table, the userInventoryURI field needs to be updated for all users.

In OSWI's config file, update "$userInventoryURI".

AssetServer_Config.xml and InventoryServer_Config.xml can be deleted from the UGRM server.

On the UGRM server, copy OpenSim.Server.ini.example to OpenSim.Server.ini and edit it, changing the "ConnectionString" entries appropriately, in the [AssetService] and [InventoryService] sections.

Bring up UGRM. Bring up regions.

Semi-unrelated Note: According to Melanie_t, any of the UGRM servers can be restarted independently,
without needing to restart the other three. However, if you restart the UserServer, you must issue
the command "register" (without the quotes) at the MessagingServer console, afterwards.

==Moving the Grid Server to ROBUST==

* Copy OpenSim.GridServer.ini.example to your own copy
* Edit it and change it so that it uses your regular Database and the usual Grid Server port
* Start U, then start the grid server like this:
$ OpenSim.Server.exe -inifile=OpenSim.GridServer.ini -logfile=/some/path/to/some/file
* Start AI and M as usual
* Start your sims

ROBUST

2009-08-19T20:07:24Z

Smxy:

==Redesigned OpenSim Basic Universal Server Technology (R.O.B.U.S.T.)==
===Concepts===
R.O.B.U.S.T. (ROBUST) leverages the system of in and out connectors and services that was developed for the Hypergrid and OpenSim. It replaces OGS1 with a modular architecture that can be easily extended using core and 3rd party modules.

R.O.B.U.S.T. (ROBUST) is a flexible server shell that can load the same modules already used by regions. This allows for nearly 100% code reusability and great flexibility.

The R.O.B.U.S.T. (ROBUST) server loads "in" connectors as specified in the configuration file. These connectors then load the required processing and storage modules and/or "out" connectors. Through this architecture, each R.O.B.U.S.T. server can run any or all grid services, and/or act as a proxy for grid services.

===Configuration===
The server reads a configuration file at startup, which defaults to the name of the assembly with .ini appended. The default name for the R.O.B.U.S.T. (ROBUST) server is OpenSim.Server.exe, therefore the default configuration file is OpenSim.Server.ini. An OpenSim.Server.ini.example file is provided with the OpenSim kit.

; * The startup section lists all the connectors to start up in this server
; * instance. This may be only one, or it may be the entire server suite.
; * Multiple connectors should be seaprated by commas.
; *
; * These are the IN connectors the server uses, the in connectors
; * read this config file and load the needed OUT and database connectors
; *
[Startup]
ServiceConnectors = "OpenSim.Server.Handlers.dll:AssetServiceConnector,OpenSim.Server.Handlers.dll:InventoryServiceInConnector"

; * This is common for all services, it's the network setup for the entire
; * server instance
; *
[Network]
port = 8003

; * As an example, the below configuration precisely mimicks the legacy
; * asset server. It is read by the asset IN connector (defined above)
; * and it then loads the OUT connector (a local database module). That,
; * in turn, reads the asset loader and database connection information
; *
[AssetService]
LocalServiceModule = "OpenSim.Services.AssetService.dll:AssetService"
DefaultAssetLoader = "OpenSim.Framework.AssetLoader.Filesystem.dll"
AssetLoaderArgs = "assets/AssetSets.xml"
StorageProvider = "OpenSim.Data.MySQL.dll"
ConnectionString = "Data Source=localhost;Database=grid;User ID=grid;Password=grid;"

; * This configuration loads the inventory server modules. It duplicates
; * the function of the legacy inventory server
; *
[InventoryService]
LocalServiceModule = "OpenSim.Services.InventoryService.dll:InventoryService"
UserServerURI = "http://127.0.0.1:8002"
SessionAuthentication = "false"
StorageProvider = "OpenSim.Data.MySQL.dll"
ConnectionString = "Data Source=localhost;Database=grid;User ID=grid;Password=grid;"

===Command Line Arguments===
*-inifile
:Specify the location of the .ini file to read instead of the default
*-console
:Specify console type, one of basic, local or rest
*-logfile
:Specify the logfile this server will log to
*-prompt
:Override the server prompt

==Configuration File==
===Section [Startup]===
*ServiceConnectors
:Comma separated list of service IN connectors. The format of each entry is <dllname>:<classname>. If a dll contains only one suitable class, the class name can be omitted.
*Prompt
:Override the server prompt
*Console
:Specify console type, one of basic, local or rest
*Logfile
:Specify the logfile this server will log to

===Section [Network]===
*Port
:Set the network port to listen on. All services will run on this port.

==Connector Configurations==
These configurations are provided by the connector modules and are not an integral part of the R.O.B.U.S.T. server. Documentation to all possible options can be found in the documentation of the connector. This manual only lists the options present in the sample configuration file.

===Section [AssetService]===
* LocalServiceModule [Connector option]
:A module specification (<dll>:<class>) that provides the services for this connector
* DefaultAssetLoader [Service option]
:A dll containing the asset loader to use for loading the default asset set
* AssetLoaderArgs [Service option]
:Path to load assets from (for the file system asset loader)
* StorageProvider [Service option]
:Dll containing the database provider code
* ConnectionString [Service option]
:Connection string to be passed to the database provider

===Section [InventoryService]===
* LocalServiceModule [Connector option]
:A module specification (<dll>:<class>) that provides the services for this connector
* UserServerURI [Connector option]
:URI to reach the user server at
* SessionAuthentication [Connector option]
:Authenticate inventory sessions (default false!)
* StorageProvider [Service option]
:Dll containing the database provider code
* ConnectionString [Service option]
:Connection string to be passed to the database provider

Additional connectors may need additional sections to be added.

==Alternate Configuration Files==
To run R.O.B.U.S.T. as separate processes, emulatig the legacy servers, you can copy the server executables to the names of the legacy servers:
cp OpenSim.Server.exe OpenSim.Grid.AssetServer.exe
cp OpenSim.Server.exe.config OpenSim.Grid.AssetServer.exe.config
cp OpenSim.Server.ini OpenSim.Grid.AssetServer.ini

Then, modify OpenSim.Grid.AssetServer.ini to read:
[Startup]
ServiceConnectors = "OpenSim.Server.Handlers.dll:AssetServiceConnector"

[Network]
port = 8003

[AssetService]
LocalServiceModule = "OpenSim.Services.AssetService.dll:AssetService"
DefaultAssetLoader = "OpenSim.Framework.AssetLoader.Filesystem.dll"
AssetLoaderArgs = "assets/AssetSets.xml"
StorageProvider = "OpenSim.Data.MySQL.dll"
ConnectionString = "Data Source=localhost;Database=grid;User ID=grid;Password=grid;"

Now, when you run OpenSim.Grid.AssetServer.exe, it will act like the legacy asset server it replaces.

You can do the same for all other supported services.

This method is working fine as a replacement of the old Asset & Inventory servers, BUT : In the 2 following files :
OpenSim.Grid.AssetServer.exe.config
OpenSim.Grid.InventoryServer.exe.config

You have to update the log filename : from "OpenSim.log" to "OpenSim.Grid.AssetServer.log" & "'OpenSim.Grid.InventoryServer.log".

Just because there is a conflict accessing the logfile ( write ) ... So, if you don't do that modification, your OpenSim.exe won't start. ( Linux / Mono 2.4.2 )

==An Example Conversion From UGAIM To UGRM==

Converting from UGAIM to UGRM:

Kudos to diva and Melanie_t for helping and tolerating me (smxy).

My setup:

Full HG-enabled, Internet-accessible, Grid Mode system, using MySQL and split over three servers.

UGAIM runs on a 32-bit CentOS 5.3 Xen VM on 64-bit CentOS 5.3. 
Each region runs in its own instance of OpenSim.exe on a 32-bit Windows XP SP3 Home system. 
MySQL 5.0 runs on a 32-bit Debian 4.0 (etch) system. 
OSWI runs on the Windows system too.

Bring down the regions. Bring down UGAIM.

Then, the port for the inventory server needs to be changed from 8004 to 8003 in a number of places:

OpenSim.ini: "inventory_server_url" - For all regions and the UGRM server. 
GridCommon.ini: "InventoryServerURI" - For all regions and the UGRM server. 
UserServer_Config.xml: "default_inventory_server" - For the UGRM server.

In the MySQL database, in the "users" table, the userInventoryURI field needs to be updated for all users.

In OSWI's config file, update "$userInventoryURI".

AssetServer_Config.xml and InventoryServer_Config.xml can be deleted from the UGRM server.

On the UGRM server, copy OpenSim.Server.ini.example to OpenSim.Server.ini and edit it, changing the two "ConnectionString" entries appropriately.

Bring up UGRM. Bring up regions.

Semi-unrelated Note: According to Melanie_t, any of the UGRM servers can be restarted independently,
without needing to restart the other three. However, if you restart the UserServer, you must issue
the command "register" (without the quotes) at the MessagingServer console, afterwards.

ROBUST

2009-08-19T20:06:30Z

Smxy: Added section on converting from UGAIM to UGRM.

==Redesigned OpenSim Basic Universal Server Technology (R.O.B.U.S.T.)==
===Concepts===
R.O.B.U.S.T. (ROBUST) leverages the system of in and out connectors and services that was developed for the Hypergrid and OpenSim. It replaces OGS1 with a modular architecture that can be easily extended using core and 3rd party modules.

R.O.B.U.S.T. (ROBUST) is a flexible server shell that can load the same modules already used by regions. This allows for nearly 100% code reusability and great flexibility.

The R.O.B.U.S.T. (ROBUST) server loads "in" connectors as specified in the configuration file. These connectors then load the required processing and storage modules and/or "out" connectors. Through this architecture, each R.O.B.U.S.T. server can run any or all grid services, and/or act as a proxy for grid services.

===Configuration===
The server reads a configuration file at startup, which defaults to the name of the assembly with .ini appended. The default name for the R.O.B.U.S.T. (ROBUST) server is OpenSim.Server.exe, therefore the default configuration file is OpenSim.Server.ini. An OpenSim.Server.ini.example file is provided with the OpenSim kit.

; * The startup section lists all the connectors to start up in this server
; * instance. This may be only one, or it may be the entire server suite.
; * Multiple connectors should be seaprated by commas.
; *
; * These are the IN connectors the server uses, the in connectors
; * read this config file and load the needed OUT and database connectors
; *
[Startup]
ServiceConnectors = "OpenSim.Server.Handlers.dll:AssetServiceConnector,OpenSim.Server.Handlers.dll:InventoryServiceInConnector"

; * This is common for all services, it's the network setup for the entire
; * server instance
; *
[Network]
port = 8003

; * As an example, the below configuration precisely mimicks the legacy
; * asset server. It is read by the asset IN connector (defined above)
; * and it then loads the OUT connector (a local database module). That,
; * in turn, reads the asset loader and database connection information
; *
[AssetService]
LocalServiceModule = "OpenSim.Services.AssetService.dll:AssetService"
DefaultAssetLoader = "OpenSim.Framework.AssetLoader.Filesystem.dll"
AssetLoaderArgs = "assets/AssetSets.xml"
StorageProvider = "OpenSim.Data.MySQL.dll"
ConnectionString = "Data Source=localhost;Database=grid;User ID=grid;Password=grid;"

; * This configuration loads the inventory server modules. It duplicates
; * the function of the legacy inventory server
; *
[InventoryService]
LocalServiceModule = "OpenSim.Services.InventoryService.dll:InventoryService"
UserServerURI = "http://127.0.0.1:8002"
SessionAuthentication = "false"
StorageProvider = "OpenSim.Data.MySQL.dll"
ConnectionString = "Data Source=localhost;Database=grid;User ID=grid;Password=grid;"

===Command Line Arguments===
*-inifile
:Specify the location of the .ini file to read instead of the default
*-console
:Specify console type, one of basic, local or rest
*-logfile
:Specify the logfile this server will log to
*-prompt
:Override the server prompt

==Configuration File==
===Section [Startup]===
*ServiceConnectors
:Comma separated list of service IN connectors. The format of each entry is <dllname>:<classname>. If a dll contains only one suitable class, the class name can be omitted.
*Prompt
:Override the server prompt
*Console
:Specify console type, one of basic, local or rest
*Logfile
:Specify the logfile this server will log to

===Section [Network]===
*Port
:Set the network port to listen on. All services will run on this port.

==Connector Configurations==
These configurations are provided by the connector modules and are not an integral part of the R.O.B.U.S.T. server. Documentation to all possible options can be found in the documentation of the connector. This manual only lists the options present in the sample configuration file.

===Section [AssetService]===
* LocalServiceModule [Connector option]
:A module specification (<dll>:<class>) that provides the services for this connector
* DefaultAssetLoader [Service option]
:A dll containing the asset loader to use for loading the default asset set
* AssetLoaderArgs [Service option]
:Path to load assets from (for the file system asset loader)
* StorageProvider [Service option]
:Dll containing the database provider code
* ConnectionString [Service option]
:Connection string to be passed to the database provider

===Section [InventoryService]===
* LocalServiceModule [Connector option]
:A module specification (<dll>:<class>) that provides the services for this connector
* UserServerURI [Connector option]
:URI to reach the user server at
* SessionAuthentication [Connector option]
:Authenticate inventory sessions (default false!)
* StorageProvider [Service option]
:Dll containing the database provider code
* ConnectionString [Service option]
:Connection string to be passed to the database provider

Additional connectors may need additional sections to be added.

==Alternate Configuration Files==
To run R.O.B.U.S.T. as separate processes, emulatig the legacy servers, you can copy the server executables to the names of the legacy servers:
cp OpenSim.Server.exe OpenSim.Grid.AssetServer.exe
cp OpenSim.Server.exe.config OpenSim.Grid.AssetServer.exe.config
cp OpenSim.Server.ini OpenSim.Grid.AssetServer.ini

Then, modify OpenSim.Grid.AssetServer.ini to read:
[Startup]
ServiceConnectors = "OpenSim.Server.Handlers.dll:AssetServiceConnector"

[Network]
port = 8003

[AssetService]
LocalServiceModule = "OpenSim.Services.AssetService.dll:AssetService"
DefaultAssetLoader = "OpenSim.Framework.AssetLoader.Filesystem.dll"
AssetLoaderArgs = "assets/AssetSets.xml"
StorageProvider = "OpenSim.Data.MySQL.dll"
ConnectionString = "Data Source=localhost;Database=grid;User ID=grid;Password=grid;"

Now, when you run OpenSim.Grid.AssetServer.exe, it will act like the legacy asset server it replaces.

You can do the same for all other supported services.

This method is working fine as a replacement of the old Asset & Inventory servers, BUT : In the 2 following files :
OpenSim.Grid.AssetServer.exe.config
OpenSim.Grid.InventoryServer.exe.config

You have to update the log filename : from "OpenSim.log" to "OpenSim.Grid.AssetServer.log" & "'OpenSim.Grid.InventoryServer.log".

Just because there is a conflict accessing the logfile ( write ) ... So, if you don't do that modification, your OpenSim.exe won't start. ( Linux / Mono 2.4.2 )

==An Example Conversion From UGAIM To UGRM==

Converting from UGAIM to UGRM:

Kudos to diva and Melanie_t for helping and tolerating me.

My setup:

Full HG-enabled, Internet-accessible, Grid Mode system, using MySQL and split over three servers.

UGAIM runs on a 32-bit CentOS 5.3 Xen VM on 64-bit CentOS 5.3. 
Each region runs in its own instance of OpenSim.exe on a 32-bit Windows XP SP3 Home system. 
MySQL 5.0 runs on a 32-bit Debian 4.0 (etch) system. 
OSWI runs on the Windows system too.

Bring down the regions. Bring down UGAIM.

Then, the port for the inventory server needs to be changed from 8004 to 8003 in a number of places:

OpenSim.ini: "inventory_server_url" - For all regions and the UGRM server. 
GridCommon.ini: "InventoryServerURI" - For all regions and the UGRM server. 
UserServer_Config.xml: "default_inventory_server" - For the UGRM server.

In the MySQL database, in the "users" table, the userInventoryURI field needs to be updated for all users.

In OSWI's config file, update "$userInventoryURI".

AssetServer_Config.xml and InventoryServer_Config.xml can be deleted from the UGRM server.

On the UGRM server, copy OpenSim.Server.ini.example to OpenSim.Server.ini and edit it, changing the two "ConnectionString" entries appropriately.

Bring up UGRM. Bring up regions.

Semi-unrelated Note: According to Melanie_t, any of the UGRM servers can be restarted independently,
without needing to restart the other three. However, if you restart the UserServer, you must issue
the command "register" (without the quotes) at the MessagingServer console, afterwards.