Installation of OpenSimulator on Windows Platforms.
A Quick Guide to a successful installation on OSGrid
OpenSim Version 0.8.x and no longer applies to 0.6.9
by WhiteStar Magic, Updated APRIL 07, 2013
(Added Router Hack
Document Ver: 0.3Overview:
In recent days numerous people have approached me about to to install OpenSim correctly in windows. While there are different methods of doing so, this guide uses Known Good Practices which work correctly since early 2009. This is not an "All Inclusive" guide but it should get you up & running without a lot of pain (hopefully).
NOTE: This is Directed @ OSGrid Installationhttp://www.osgrid.org/index.php/downloadsGeneral Information:
All Windows Operating systems come installed with NET Framework 2.0 by default. This applies to Windows XP, Vista, Win-7 and many of the Windows Servers (2003 & 2008). OpenSimulator 0.8.0 requires NET Framework 4.0 Minimum to run. This is not automatically installed or updated and therefore you have to install it first. Microsoft provides 2 methods of doing so, 1)
is a bootstrapper which often will have issues and 2)
is from the full package which works 99% of the time.
Download it it from: http://www.microsoft.com/en-us/download ... x?id=17851NOTE: Windows 8 will want to update Net Framework to Version 4.5, that is fine, it works
Windows, like many other operating systems has a physical limit of a 255 characters for Directory Path length. OpenSim will exceed that limit if it is in the wrong place. Additionally, OpenSim needs to read and write to it's sub-directory structures and there cannot be installed in Program Files as Windows will protect that System Area.NOTE: This is for the Default Installation using SqlLite
. This is to get you up & running quickly, SqlLite is NOT intended for long term operation or where are are going to be building and having guests. There is a Tutorial for migrating to MySql, it is slightly dated but still works as expected available here @ http://chapter-and-metaverse.blogspot.c ... mysql.htmlInstallation Steps:
Download Opensim from OSGrid.org. @ http://www.osgrid.org/index.php/downloads
Make a directory @ c:\opensim
or select another drive if applicable.
Unzip the OpenSim ZIP file to that directory and you should see c:\opensim\bin
with a bunch of sub-directories.
Setting Permission on the directory:Right Click
on c:\opensim, select Properties, Security, select EDIT button, Select ADD button, Add your user name on the PC and give that account FULL CONTROL. (This varies a little between versions of Windows)Configuration of OpenSim:
Next, we need to startup OpenSim and it will prompt you with several questions.
Change Directory to c:\opensim\bin
double click on OpenSim.exe
which now works for both 32 & 64 bit Windows, all flavours.
** See Notes @ bottom of this section for further details on how to obtain the required info being requested.
OpenSim Starts in a CMD/DOS Box and prompts as shown below:
OpenSim will now ask you Questions as shown below.
You can press 'enter' without typing anything to use the default. The default is displayed between [ ]: brackets.SETUP QUESTIONS Part-1
New region name : Your RegionName Here
Region UUID [79eacd60-fafb-11de-8a39-0800200c9a66]:
Region Location [1000,1000]: Enter the X,Y coordinates Here
Internal IP address [0.0.0.0]: Press Enter
Internal port : Press Enter
Allow alternate ports [False]: Press Enter
External host name [SYSTEMIP]: Enter your IP Address or DNSnameSETUP QUESTIONS Part-2
Do you wish to join an existing estate? [no]: Press Enter
Estate name to join [None]: ENTER your EstateName
Estate owner first name [Test]: ENTER your Avatars FirstName
Estate owner last name [User]: ENTER your Avatars LastName
Once you have entered the Information, you will see a New bin\regions\Region.ini with the region info in it which you have just provided. The Instance will start and you will find yourseldf at the #prompt in the OpenSim Console.Information for SETUP QUESTIONS Part-1 & 2** how to get the needed info:
- Your Region Name is whatever you choose, No Special Characters may be in it.
- Region UUID can be obtained from http://www.famkruithof.net/uuid/uuidgen Some versions will put a UUID there, others will not, IF it does then hit ENTER to accept it
- Region Location, X,Y Coordinates for OSGrid for ONE free Region Location @ http://download.osgrid.org/autocoord/
- Press Enter = Press Enter to accept defaults.
- IP Address / DNS Name: to get your External IP Address use: http://download.osgrid.org/autoip/ *NB Most 99% of use DHCP Addressing which change regularly, it is far better to use a DNS Name, see sub notes.
- Join Existing Estate You have to say no, currently a yes will fail
- Estate Name is whatever you choose, No Special Characters and a Space in the name is OK
- Your Firstname & Lastname are for your OSG Avatar
IP / DHCP & DNS:
A Simple solution for a changing IP Address is to use a DNSname. This can be easily facilitated by going and registering @ http://www.dyndns.com/ and getting a 'Free Dynamic DNS" and installing their utility on your PC which monitors your IP Address and maintains the DNS Redirection to your PC.
Windows Firewall can be a little tedious but in recent updates and in Vista / Win-7 / Server 2008 it has become quite a bit easier. The next steps require you to open certain ports in the firewall for inbound and outbound communications. Certain things you will need to note if what the previously entered port was (default 9000) and any additional ports added for other regions (likely your will add more later, not in this guide but we are going to extend it a little to save that step later for you). We will be opening ports 9000-9005 in this exercise. [b]**NB** I will only show TCP here but this must also be done for UDP and is exactly the same steps.
Go to your Control Panel from Start Menu. Control Panel\System and Security\Windows Firewall
Repeat for UDP as shown above.
- Select the Advanced Tab
- Select New Rule (At the top right side of the screen)
- Select the Port Button then NEXT>
- Select TCP or UDP if doing that) then Specific Local Ports, Enter 9000-9005, NEXT>
Both TCP & UDP must be done.
- Select Allow the Connection if not already selected, NEXT>
- Select All 3 Check Boxes (Domain, Private, Public), NEXT>
- Name it "OpenSim-TCP" or "OpenSim-UDP", SAVE
Next, double click on the newly created rule and open it up
Repeat for the UDP Rule created above.Repeat the Same Steps Above for TCP & UDP in the Outbound Rules Section.
- Select the "Programs and Services" tab
- Select "This Program" and type in "c:\opensim\bin\OpenSim.exe" OR OpenSim.32BitLaunch.exe
! You can also browse to it, if you wish.
- Click the Apply button.
- Next, select "Protocols and Ports" tab and double check the ports are 9000-9005
- Next, select the "Advanced" tab. All three profiles should be checked
- Set the "Edge Traversal" to "Defer to application" in the drop down box. Click Apply, Then OK
The ONLY Difference in the Advanced Tab, there is no edge traversal section.
When Done. Close the Firewall App and close Control Panel.Congratulations, your 90% of the way there.ROUTERS:No Router !
If your don't have one then BE HAPPY and double click on OpenSim.exe or OpenSim.32BitLaunch.exe and watch it load, login to OSG, Map to your RegionName, TP there and Set Home. DONE. Have a look at the reference section below for more stuff and articles etc...You have a Router !
Ahhh .... The Big Bad and Ugly. This is where most people have issues / problems. This would require a VERY LARGE discussion to sort out. Here's the bottom line on this, There are literally 100's if not thousands of routers out there so it is literally impossible to address it here. You need to ensure that you have a Router that is capable of "LoopBack". Without Loopback you are going to have no end of issues and OpenSim will not run properly, if at all. You simply will not be able to get to it. Sadly, Probably 75% of the routers on the market today do not have Loopback. Some Handy Router Info Here: viewtopic.php?f=8&t=2283GOOD NEWS !
Thanks to a New Discovery from someone on IRC There is another solution to LoopBack Issues. I have not tested it but check it out, as others have.http://hotspotshield.com/
Little software you install and it re-routes from outside.
More Information Related to Routers:viewtopic.php?f=8&t=2283http://opensimulator.org/wiki/NAT_Loopback_Routershttp://opensimulator.org/wiki/Users:Thomax:nat-loopbackhttp://www.portforward.com/english/rout ... rindex.htmWindows Hosts File Trick!
- The Router has to forward the incoming TCP & UDP to the PC, so this needs to be setup similar to what we did with the firewall on the PC.
- The Router needs to have Loopback to send data back to the PC when your are accessing locally or from inside your "Home Lan".
- The Router's Firewall (if it has one) will often cause issues and in most cases if it cannot be configured as previously noted, it will need to be disabled.
Sometimes this can help see for more info.http://en.wikipedia.org/wiki/Hosts_fileRouter Hack
Here are a Few Links that will help you setup Microsoft Software Loopback Adapter. This is NOT a perfect Solution (see HACK) and "may" work for you but it is an option that is available.http://www.windowsreference.com/windows ... windows-7/http://blogs.msdn.com/b/briankel/archiv ... vista.aspxhttp://support.microsoft.com/kb/839013
<--- how-to-install-a-loopback-adapter-in-windows-XPGENERAL REFERENCE INFORMATION:
OpenSimulator.Org The Home of OpenSimulator!Http://opensimulator.org
Connecting a region to OSGrid:http://www.osgrid.org/index.php/regionconnect
Running OpenSim, Home, Hosted etc...viewtopic.php?f=9&t=1360&start=0
Microsoft Net Framework:http://www.microsoft.com/en-us/download ... x?id=17851
Migrating from SqlLite to MySql:http://chapter-and-metaverse.blogspot.c ... mysql.html
System Batch Files to assist with day to day OpenSim Operation & Maintenance http://opensimulator.org/wiki/Running
Setting Up Mega-Regions http://opensimulator.org/wiki/Setting_Up_Mega-RegionsTROUBLESHOOTING:
Your IP Info & Port Scanning & Diags: http://www.t1shopper.com/tools/port-scan/
TraceRoute Testing from 4 global locations: (good for speed testing etc)http://www.just-traceroute.com
OSGgrid Forums: (login with your Avatar user name & password)index.php
OSGrid IRC Text Chat Web Client: (Text Chat with other OSG folks that can help you out)http://www.osgrid.org/index.php/freenode*** NOTE ***
Everyone in OSG is a Volunteer, there is NO PAID STAFF ! When joining IRC or asking for help, be patient and ask your question directly. If someone is watching (often we are not sitting there watching) they will answer or someone may come along and see the Question and help.
edit: update version and some urls