Dependencies

From OpenSimulator

(Difference between revisions)
Jump to: navigation, search
(→‎Windows: It is not good idea to disable windows firewall itself, it works enough by just modifying existing rule)
(→‎Version 0.9.3.0 and above)
 
(60 intermediate revisions by 13 users not shown)
Line 1: Line 1:
−
__NOTOC__ {{Template:Quicklinks}} <br>In addition to the OpenSim code itself, certain other packages need to be installed on different platforms in order to get OpenSim binaries to run.
+
{{Quicklinks}}
  
−
As well as the information on this page (which should be expanded), you may find more information on dependencies in [[Build Instructions]] though this will also contain dependencies required only for building. This are also more hints in [[Troubleshooting]]
+
= Note =
  
 +
These instructions assume that OpenSimulator is running from the binary packages in standalone mode.  If this is not the case or you have more complex requirements (e.g. you want to use the MySQL database rather than SQLite or you want to run in grid mode), then you will need to [[Configuration|configure]] OpenSimulator first.
  
−
= Windows  =
+
= Dependencies =
 +
In addition to the OpenSimulator code itself, certain other packages need to be installed on different platforms in order to get OpenSimulator binaries to run.
  
−
OpenSim now requires '''.NET Framework 3.5''' when running under Windows.  If you run OpenSimulator on '''Windows 7''' or '''Windows Server 2008 R2''', it is already bundled so you can run OpenSim 0.7.1 out-of-the-box. On '''Windows Vista''', '''Windows Server 2008''', '''Windows Server 2003''' or '''Windows XP''', you'll need to upgrade it to 3.5(or later, but NET Framework 4.0 not officially supported by OpenSim yet), downloading from [http://msdn.microsoft.com/en-us/netframework/cc378097 Microsoft .NET Framework Download Page@.NET Framework Developer Center]. Note that prior versions of Windows(ex. NT or 2000) are NOT supported.
+
As well as the information on this page (which should be expanded), you may find more information on dependencies in [[Build Instructions]] though this will also contain dependencies required only for building. This are also more hints in [[Troubleshooting]].
  
−
If you run on Windows XP ensure it is updated to at least Service Pack 2 (SP2).  
+
After solving dependencies, you may need to configure the firewall installed in your system by default so that the viewers outside can access to OpenSimulator inside it. See [[Firewall Settings]] for more informations.
  
−
Double-click or execute on command prompt:
+
[[NAT Loopback Routers]] Router and Nat Loopback Information to help you configure your Router / Modem.
−
*32-bit version of Windows: '''OpenSim.exe'''
+
−
*64-bit version of Windows: '''OpenSim.32BitLaunch.exe'''
+
−
Depending on your installation, you may have to run the program as administrator(right click -> 'Run as administrator'). It will pop up a window asking permission, select "Allow".
+
  
 +
= Version 0.9.3.0 and above =
  
 +
* [https://dotnet.microsoft.com/en-us/download/dotnet/8.0 dotnet8] runtime or Desktop runtime for your platform (also the SDK if you wish to compile)
 +
* On Windows you may need to install the [https://docs.microsoft.com/en-us/cpp/windows/latest-supported-vc-redist?view=msvc-170 run time files for vc++]
 +
* On windows you may need to authorize the install of older .NetFramework 3.5
 +
* on linux you will need libgdiplus
 +
**if you have mono 6.x complete installed, you already have libgdiplus, otherwise you need to install it for example on debian:
 +
**apt-get update && apt-get install -y apt-utils libgdiplus libc6-dev
  
−
'''''Windows Firewall'''''
+
= Older Versions =
  
−
On Server 2008, Vista or Windows 7, you'll need to configure the "Windows Firewall with Advanced Security" to enable access from the viewers on another machines.
+
== Windows ==
  
−
Click Start and then click Control Panel. In the Control Panel, click System and Security and then click Administrative Tools. In Administrative Tools, double-click Windows Firewall with Advanced Security. Or you can even direct access by typing "WF.msc" in the Run textbox in the start menu.
+
OpenSimulator 0.9.2.2 release code requires requires .NET Framework 4.6.<br>
 +
You may also need to install the [https://docs.microsoft.com/en-us/cpp/windows/latest-supported-vc-redist?view=msvc-170 run time files for vc++]
  
−
In the Windows Firewall with Advanced Security, in the left pane, right-click Inbound Rules. Right click on "opensim.exe" entry. From the context menu that appears select Properties. Then, on the General tab, under Action, select the "Allow the connections" option and click OK. Note that "opensim.exe" entry will be created when you run OpenSim.exe the first time.
+
Double-click or execute on command prompt:
 +
*'''OpenSim.exe'''
  
 +
On 64bit machines you can run small regions in 32bit mode, double-click or execute on command prompt:
 +
*'''OpenSim32.exe'''
  
−
'''''McAfee Security'''''
+
Depending on your installation, you may have to run the program as administrator(right click -> 'Run as administrator'). It will pop up a window asking permission, select "Allow".
  
−
McAfee Security does not allow applications to listen on ports not explicitly specified. You have two options: 1) disable firewall protection all together, 2) enable <tt>OpenSim.exe</tt> to be able to open ports.
+
== Linux and Mac OSX ==
  
−
Disable Firewall - Open McAfee SecurityCenter. Select "Internet &amp; Network". In the lower left corner is a small link to "Configure...". Select this. In the right side of the window, select the bar that says "Firewall protection is enabled". Here you can select "Off".  
+
{| class="wikitable"
 +
|-
 +
! scope="col"| Mono version
 +
! scope="col"| OpenSimulator version
 +
! scope="col"| Status
 +
! scope="col"| Notes
 +
|-
 +
! scope="row"| 2.4.3+
 +
| 0.7.6
 +
| Ok
 +
|
 +
|-
 +
! scope="row"| 2.6.x
 +
| < 0.7.6
 +
| Ok
 +
| Appears to be fine, though the mono VM does seem to have some issues (crashing with a native stacktrace) on simulators running many regions or lots of users/prims
 +
|-
 +
! scope="row"| 2.8.x
 +
| *
 +
| Not ok
 +
| Significant performance and scalability problems
 +
|-
 +
! scope="row"| 2.10.0
 +
| *
 +
| Not ok
 +
| Significant performance and scalability problems
 +
|-
 +
! scope="row"| 2.10.1
 +
| *
 +
| Not ok
 +
| Significant performance and scalability problems
 +
|-
 +
! scope="row"| 2.10.2
 +
| *
 +
| Ok
 +
|
 +
|-
 +
! scope="row"| 2.10.8
 +
| < 0.9
 +
| Ok (recommended)
 +
|
 +
|-
 +
! scope="row"| 2.10.9 > 3.0.3
 +
| *
 +
| Not ok
 +
| Major issues
 +
|-
 +
! scope="row"| 3.0.7
 +
| *
 +
| Ok
 +
|
 +
|-
 +
! scope="row"| 4.0
 +
| *
 +
| Not Ok
 +
|
 +
|-
 +
! scope="row"| 4.0.4
 +
| *
 +
| Ok
 +
|
 +
|-
 +
! scope="row"| 4.3.2
 +
| *
 +
| Ok
 +
|
 +
|-
 +
! scope="row"| 4.4.2
 +
| *
 +
| Not Ok
 +
| Some issues on Robust like NameResolutionFailure
 +
|-
 +
! scope="row"| 4.6.2.16
 +
| *
 +
| Not Ok
 +
|
 +
|-
 +
! scope="row"| 5.x
 +
| *
 +
| seems to work
 +
| but : http://opensimulator.org/mantis/view.php?id=8251
 +
|-
 +
! scope="row"| >=5.12
 +
| >=0.9.1
 +
|
 +
|
 +
|-
 +
|}
  
−
Enable <tt>OpenSim.exe</tt> to Open Ports - Open McAfee SecurityCenter. Select "Internet &amp; Network". In the lower left corner is a small link to "Configure...". Select this. In the right side of the window, select the bar that says "Firewall protection is enabled". Select the "Advanced..." button. This will pop up a new window.
 
  
−
In the new window, on the left side, select "Program Permissions." In the middle on the right side of the window, select the "Add Allowed Program" button. Use the browser that pops up to find the OpenSim executable and select it.  
+
OpenSimulator development code requires Mono 5.12 or later.
  
−
Finally, select "OK" and exit the McAfee SecurityCenter window.
+
To run OpenSimulator with mono, execute on folder ../bin
  
−
= Linux =
+
  ./opensim.sh
  
−
OpenSimulator requires Mono 2.4.3 or later.
+
You can edit that shell script if you need, to change Regional Setting (see bellow) or other parameters like stack size for ODE based physics engines.
  
−
== Ubuntu ==
+
On Mac Os with mono5.x you can run OpenSimulator in 32bit mode changing the mono execution line on that script to:
  
−
sudo apt-get install nant mono-gmcs libmono-microsoft8.0-cil \
+
mono --desktop --arch=32 OpenSim.exe
−
      libmono-system-runtime2.0-cil libgdiplus libmono-i18n2.0-cil libmono-oracle2.0-cil
+
  
−
Nant is required if you need to build OpenSim.
 
  
−
{{anchor|CentOS}}{{anchor|RedHat}}{{anchor|RHEL}}{{anchor|Fedora}}
 
−
== RHEL, Fedora, CentOS or Any Other RedHat-based Distributions  ==
 
  
−
First, run "yum info mono-core" to see the version of the mono packages in the core repository for your distribution. If it shows '''2.4.3''' or later, proceed to [[#Installing from Core Repository]]. If not, skip to [[#Installing from Mono Repository]]. Note that the current version you can get from yum repository for some distributions is lower than requirement (ex. '''1.2.4''' on CentOS). Unlike Ubuntu, RedHat-based distributions should be always conservative, therefore it is natural that they don't so often update their repository. What you can do to manage this problem is to add an extra repository for mono.
+
=== Getting Mono ===
  
−
=== Installing from Core Repository ===
+
You can install mono from [https://www.mono-project.com/download/stable/ Mono Official Download Page].
 +
If you system is not supported, you will need to get its sources and compile on it.
  
−
Just type:
+
== Docker ==
−
<pre>
+
−
sudo yum install  mono-core mono-data-sqlite mono-extras libgdiplus
+
−
</pre>
+
−
It will also install dependent modules. After that you can launch OpenSim.exe with mono out-of-the-box.
+
  
−
=== Installing from Mono Repository ===
+
For testing purposes, you can even run OpenSimulator as Docker containers. The quickest way would be to use [https://hub.docker.com/_/mono/ official docker mono image] as base image. To avoid first-run questionaries, you need to prepare a series of ini files and deploy them on the container. For example, if you run 0.9.0.0-rc1 binary in Standalone mode on Mono 4.6.2.16:
  
−
This procedure is tested on CentOS 5.5 & 5.6 box with OpenSim 0.7.1.
 
−
 
−
Go to yum config file folder and create new one for mono.
 
 
<pre>
 
<pre>
−
cd /etc/yum.repos.d
+
FROM mono:4.6.2.16
−
sudo vi mono.repo
+
−
</pre>
+
  
−
And then in mono.repo :
+
RUN curl http://dist.opensimulator.org/opensim-0.9.0.0-rc1.tar.gz -s | tar xzf -
−
<pre>
+
COPY Regions.ini /opensim-0.9.0.0-rc1/bin/Regions/Regions.ini
−
[mono]
+
COPY OpenSim.ini /opensim-0.9.0.0-rc1/bin/OpenSim.ini
−
name = novell-mono
+
EXPOSE 9000
−
baseurl=http://ftp.novell.com/pub/mono/download-stable/RHEL_5/
+
WORKDIR /opensim-0.9.0.0-rc1/bin
−
enabled=1
+
−
gpgcheck=0
+
−
</pre>
+
  
−
Now, you can yum install the later version of mono from this repository. Additional note that make sure all of mono packages are i386(not IA64 build). If your box is 32bit, don't care and you can even install properly without ".i386" suffix.
+
CMD [ "mono", "./OpenSim.exe" ]
−
<pre>
+
−
sudo yum install mono-addon-core.i386 mono-addon-data.i386 mono-addon-data-sqlite.i386  \
+
−
      mono-addon-extras.i386 mono-addon-web.i386 mono-addon-winforms.i386 mono-addon-libgdiplus0.i386
+
 
</pre>
 
</pre>
  
−
Yum will install mono into /opt/novell/mono, so you can create a symbolic link to /usr/bin :
+
In most cases, you should care about "ExternalHostName" in Regions.ini. The value should be valid hostname which can be accessed from outside of docker machine. In general, it would be "localhost" or the hostname of the docker machine which the container resides in.
 +
 
 +
Then build it and run like that. Note that you will need to forward both TCP and UDP port.
 +
 
 
<pre>
 
<pre>
−
sudo ln -s /opt/novell/mono/bin/mono /usr/bin/mono
+
$ docker build -t opensim .
 +
$ docker run --name=opensim -p 9000:9000 -p 9000:9000/udp -d opensim
 +
or
 +
$ docker run --name=opensim -it -p 9000:9000 -p 9000:9000/udp opensim
 
</pre>
 
</pre>
  
−
After that, you should be able to launch OpenSim.exe without any errors.
+
You can find full sample Dockerfile project at [https://github.com/Makopo/docker-opensimulator-simple makopo/docker-opensimulator-sample].
−
 
+
−
 
+
−
= Mac OS X =
+
−
 
+
−
All you have to do is to fetch Mono '''Runtime''' package from [http://www.go-mono.com/mono-downloads/download.html Mono Download Page] and install it.
+
−
 
+
  
 
= Locales and Regional Settings =
 
= Locales and Regional Settings =
Line 112: Line 190:
  
 
== Windows ==
 
== Windows ==
−
If you are not using an English regional setting in Windows by default, then there is not a solution as easy as for Linux, unfortunately. I did it with an additional user account that I created just for OpenSim in which I set the regional setting to "English (US)". I run OpenSim.exe from my normal user account with "Run as..." (or check "Run with different credentials" in a shortcut's advanced properties) and specify the OpenSim account as the one to be used.
+
If you are not using an English regional setting in Windows by default, then there is not a solution as easy as for Linux, unfortunately. I did it with an additional user account that I created just for OpenSimulator in which I set the regional setting to "English (US)". I run OpenSim.exe from my normal user account with "Run as..." (or check "Run with different credentials" in a shortcut's advanced properties) and specify the OpenSimulator account as the one to be used.
−
 
+
  
−
= Additional Resources =
+
= Additional Resources =
  
 
OSGrid Technical Support Forum with many installation tutorials:&nbsp; [http://osgrid.org/forums/viewforum.php?f=14 osgrid.org/forums/viewforum.php]  
 
OSGrid Technical Support Forum with many installation tutorials:&nbsp; [http://osgrid.org/forums/viewforum.php?f=14 osgrid.org/forums/viewforum.php]  
  
 
MONO&nbsp;Project:&nbsp; [http://www.mono-project.com/Main_Page www.mono-project.com/Main_Page]
 
MONO&nbsp;Project:&nbsp; [http://www.mono-project.com/Main_Page www.mono-project.com/Main_Page]

Latest revision as of 14:45, 20 April 2024

Languages Languages: 

En.png English   De.png Deutsch   Fr.png Français   Jp.png 日本語

Contents

[edit] Note

These instructions assume that OpenSimulator is running from the binary packages in standalone mode. If this is not the case or you have more complex requirements (e.g. you want to use the MySQL database rather than SQLite or you want to run in grid mode), then you will need to configure OpenSimulator first.

[edit] Dependencies

In addition to the OpenSimulator code itself, certain other packages need to be installed on different platforms in order to get OpenSimulator binaries to run.

As well as the information on this page (which should be expanded), you may find more information on dependencies in Build Instructions though this will also contain dependencies required only for building. This are also more hints in Troubleshooting.

After solving dependencies, you may need to configure the firewall installed in your system by default so that the viewers outside can access to OpenSimulator inside it. See Firewall Settings for more informations.

NAT Loopback Routers Router and Nat Loopback Information to help you configure your Router / Modem.

[edit] Version 0.9.3.0 and above

  • dotnet8 runtime or Desktop runtime for your platform (also the SDK if you wish to compile)
  • On Windows you may need to install the run time files for vc++
  • On windows you may need to authorize the install of older .NetFramework 3.5
  • on linux you will need libgdiplus
    • if you have mono 6.x complete installed, you already have libgdiplus, otherwise you need to install it for example on debian:
    • apt-get update && apt-get install -y apt-utils libgdiplus libc6-dev

[edit] Older Versions

[edit] Windows

OpenSimulator 0.9.2.2 release code requires requires .NET Framework 4.6.
You may also need to install the run time files for vc++

Double-click or execute on command prompt:

  • OpenSim.exe

On 64bit machines you can run small regions in 32bit mode, double-click or execute on command prompt:

  • OpenSim32.exe

Depending on your installation, you may have to run the program as administrator(right click -> 'Run as administrator'). It will pop up a window asking permission, select "Allow".

[edit] Linux and Mac OSX

Mono version OpenSimulator version Status Notes
2.4.3+ 0.7.6 Ok
2.6.x < 0.7.6 Ok Appears to be fine, though the mono VM does seem to have some issues (crashing with a native stacktrace) on simulators running many regions or lots of users/prims
2.8.x * Not ok Significant performance and scalability problems
2.10.0 * Not ok Significant performance and scalability problems
2.10.1 * Not ok Significant performance and scalability problems
2.10.2 * Ok
2.10.8 < 0.9 Ok (recommended)
2.10.9 > 3.0.3 * Not ok Major issues
3.0.7 * Ok
4.0 * Not Ok
4.0.4 * Ok
4.3.2 * Ok
4.4.2 * Not Ok Some issues on Robust like NameResolutionFailure
4.6.2.16 * Not Ok
5.x * seems to work but : http://opensimulator.org/mantis/view.php?id=8251
>=5.12 >=0.9.1


OpenSimulator development code requires Mono 5.12 or later.

To run OpenSimulator with mono, execute on folder ../bin 

./opensim.sh

You can edit that shell script if you need, to change Regional Setting (see bellow) or other parameters like stack size for ODE based physics engines.

On Mac Os with mono5.x you can run OpenSimulator in 32bit mode changing the mono execution line on that script to:

mono --desktop --arch=32 OpenSim.exe


[edit] Getting Mono

You can install mono from Mono Official Download Page. If you system is not supported, you will need to get its sources and compile on it.

[edit] Docker

For testing purposes, you can even run OpenSimulator as Docker containers. The quickest way would be to use official docker mono image as base image. To avoid first-run questionaries, you need to prepare a series of ini files and deploy them on the container. For example, if you run 0.9.0.0-rc1 binary in Standalone mode on Mono 4.6.2.16: 

FROM mono:4.6.2.16

RUN curl http://dist.opensimulator.org/opensim-0.9.0.0-rc1.tar.gz -s | tar xzf -
COPY Regions.ini /opensim-0.9.0.0-rc1/bin/Regions/Regions.ini
COPY OpenSim.ini /opensim-0.9.0.0-rc1/bin/OpenSim.ini
EXPOSE 9000
WORKDIR /opensim-0.9.0.0-rc1/bin

CMD [ "mono",  "./OpenSim.exe" ]

In most cases, you should care about "ExternalHostName" in Regions.ini. The value should be valid hostname which can be accessed from outside of docker machine. In general, it would be "localhost" or the hostname of the docker machine which the container resides in.

Then build it and run like that. Note that you will need to forward both TCP and UDP port. 

$ docker build -t opensim .
$ docker run --name=opensim -p 9000:9000 -p 9000:9000/udp -d opensim
or
$ docker run --name=opensim -it -p 9000:9000 -p 9000:9000/udp opensim

You can find full sample Dockerfile project at makopo/docker-opensimulator-sample.

[edit] Locales and Regional Settings

OpenSimulator will only work properly when you run it with an English locale or regional setting. With other settings than English, you are likely to see a variety of issues, ranging from misbehaving scripts to crashes.

[edit] Linux

In Linux, you can easily use the standard "C" locale just for running OpenSim.exe, as explained in Troubleshooting#ScriptEngine Issues: 

env LANG=C mono OpenSim.exe

For information about changing your locale in a more general way, see Troubleshooting#Locales Issues

[edit] Windows

If you are not using an English regional setting in Windows by default, then there is not a solution as easy as for Linux, unfortunately. I did it with an additional user account that I created just for OpenSimulator in which I set the regional setting to "English (US)". I run OpenSim.exe from my normal user account with "Run as..." (or check "Run with different credentials" in a shortcut's advanced properties) and specify the OpenSimulator account as the one to be used.

[edit] Additional Resources

OSGrid Technical Support Forum with many installation tutorials:  osgrid.org/forums/viewforum.php

MONO Project:  www.mono-project.com/Main_Page

Retrieved from "http://opensimulator.org/index.php?title=Dependencies&oldid=54199"
Personal tools
General
About This Wiki