OpenSimulator - User contributions [en]

Wifi

2011-05-15T10:42:04Z

Cliveg: /* PLEASE NOTE */

{{quicklinks}}
{{thirdparty}}
'''Wifi - A Simple Account Management Front-end'''

"Wifi" stands for "Web Interface For... I", and is an '''add-on''' module which is not a standard part of OpenSim. It is provided by Diva Canto and can be added to OpenSim 0.7 onwards.

== '''PLEASE NOTE''' ==
'''Some information on this page is out of date. Versions of Wifi are available for use with a ROBUST server grid implementation of OpenSim and as part of the standalone Diva distribution of OpenSimulator. Wifi is NOT intended to work with standalone implementations of OpenSim. Because of this certain information on this page may be misleading'''

For detailed and up to date information on Wifi please see Diva's documentation

----

== Introduction ==
'''


Wifi provides an embedded Web application for handling user registrations. Wifi is a set of components that can be loaded up by both standalone simulators and [[ROBUST]] servers.

Its features include:

* Account creation, optionally controlled by the administrator
* Configurable default avatars for new accounts
* Account updates by both users and administrator
* Account deletion by administrator
* Password recovery via email
* Simple management of user inventory 
* A welcome page which can be used as login page for the user's viewer.

Wifi has a few interesting properties that make it a good fit for small-to-medium OpenSimulator-based virtual worlds.

# It doesn’t require an additional web server; it’s all done with built-in OpenSimulator features.
# Using OpenSimulator features bring many technical benefits. These benefits aren't visible immediately, but it will show its value in the future. Unlike other Web apps that access the database directly, Wifi works by communicating with OpenSimulator directly. This means that any future changes to the OpenSimulator database structure, will not affect Wifi.
# Technically speaking, Wifi is a set of components that can be used by both standalone sims, as well as [[ROBUST]] (Grid) servers.

== Adding Wifi to your OpenSim Setup ==

'''Additions to Standard OpenSim Distribution (from 0.7 onwards)'''

=== Binary Approach ===

Obtain the latest Wifi module distribution zip from
http://github.com/diva/d2/downloads
and place the files as instructed in the equivalent locations in your OpenSim directory.

bin directory
* add bin/Diva.Wifi.dll
* add bin/Diva.Wifi.ScriptEngine.dll
* add bin/Diva.OpenSimServices.dll
* for standalones, also add bin/Diva.Modules.dll

Copy WifiPages directory and its contents to OpenSim top level directory.

doc directory
* add in doc/WIFI.txt

Copy over the WIFI related readme, release notes and licence text files.

For grids, edit Robust(.HG).ini in section [Startup] to add 8002/Diva.Wifi.dll:WifiServerConnector to <code>ServiceConnectors</code>.

For standalones, edit StandaloneCommon.ini in section [Modules] to add <code>WifiModule = true</code>.

Add a new section [WifiService] from example at http://github.com/diva/diva-distribution/blob/master/addon-modules/Wifi/Wifi.ini.example to Robust(.HG).ini (for grids) or StandaloneCommon.ini (for standalones).

=== Source Code Approach ===

Get Diva Distribution which contains the Wifi modules from
http://github.com/diva/diva-distribution/

== Setting Configuration Parameters for a Grid ==

The complete example file is here:
http://github.com/diva/diva-distribution/blob/master/addon-modules/Wifi/Wifi.ini.example

'''Additions to Robust.ini or Robust.HG.ini for Grids'''

<source lang="ini">[Startup]
ServiceConnectors = "8002/Diva.Wifi.dll:WifiServerConnector"
</source>

Note that it will be usual to specify the port number to be accessible outside your firewall (normally port 8002) rather than the default Network Port for internal inter-component OpenSim traffic (normally port 8003) which can be set to only be accessible within a firewall.

<source lang="ini">[WifiService]
GridName = "grid name"
LoginURL = "http://<hostname>:8002"
WebAddress = "http://<hostname>:8002"

;; The Wifi Administrator account
AdminFirst = "Wifi"
AdminLast = "Admin"
AdminEmail = "you@example.com"

;; Do you want to be able to control grid registrations?
AccountConfirmationRequired = false

;; Default avatars for new account registration
;; Syntax: AvatarAccount_<AvatarType> = "<FirstName> <LastName>"
;; Appearance and attachments are copied from avatar <FirstName> <LastName>.
AvatarAccount_Female = "Female Avatar"
AvatarAccount_Male = "Male Avatar"
AvatarAccount_Neutral = "Neutral Avatar"

;; Preselection for default avatar in new account registration
AvatarPreselection = "Neutral"

;; Variables for your mail server
;; Users will get email notifications from this account.
SmtpHost = "mail.example.com"
SmtpPort = "587"
SmtpUsername = "your_account_in_this_mail_server"
SmtpPassword = "your_password_in_this_mail_server"
</source>

== Setting Configuration Parameters for a Standalone ==

The complete example file is here:
http://github.com/diva/diva-distribution/blob/master/addon-modules/Wifi/Wifi.ini.example

'''Additions to config-include/StandaloneCommon.ini for Standalones'''

<source lang="ini">[Modules]
WifiModule = true

[WifiService]
GridName = "grid name"
LoginURL = "http://<hostname>:9000"
WebAddress = "http://<hostname>:9000"

;; The Wifi Administrator account
AdminFirst = "Wifi"
AdminLast = "Admin"
AdminEmail = "you@example.com"

;; Do you want to be able to control grid registrations?
AccountConfirmationRequired = false

;; Default avatars for new account registration
;; Syntax: AvatarAccount_<AvatarType> = "<FirstName> <LastName>"
;; Appearance and attachments are copied from avatar <FirstName> <LastName>.
AvatarAccount_Female = "Female Avatar"
AvatarAccount_Male = "Male Avatar"
AvatarAccount_Neutral = "Neutral Avatar"

;; Preselection for default avatar in new account registration
AvatarPreselection = "Neutral"

;; Variables for your mail server
;; Users will get email notifications from this account.
SmtpHost = "mail.example.com"
SmtpPort = "587"
SmtpUsername = "your_account_in_this_mail_server"
SmtpPassword = "your_password_in_this_mail_server"
</source>

== Configurable Default Avatars ==
[[Image:Openvue-avatars-male-female-neutral-2010-08-27.jpg|300px|right|Example Avatars]]
When users sign up, they can choose between default avatars. It's up to you to decide what these default avatars look like. Here is how you can configure them... Once your OpenSim is up and running, create accounts (using Wifi) with the names given in your configuration. With the above examples, these would be:
* Male Avatar
* Female Avatar
* Neutral Avatar

Then login to the world under each of those accounts, and set their appearances however you like. You can add prim attachments.

== Problems with HTTP ports ==

The port used for the Wifi HTTP service is configurable. Usually this will be 8002 for a grid and 9000 for a standalone unless you use custom ports.

For a standalone you can do this by adding the "port" line for the port to use for Wifi and other services to the [Network] section of OpenSim.ini

<source lang="ini">[Network]
port = 9000
</source>

Or for a grid specify a specific port (usually 8002) for the WifiServiceConnector in the ServiceConnectors list in the [Startup] section of Robust(.HG).ini

<source lang="ini">[Startup]
ServiceConnectors="............,8002/Diva.Wifi.dll:WifiServerConnector"
</source>

In either case, define the equivalent WebAddress in the [WifiService] section of your StandaloneCommon.ini or Robust(.HG).ini (or addon-modules/Wifi/config/Wifi.ini if used in future).

<source lang="ini">[WifiService]
WebAddress = "http://hostname:8002"
</source>

If you do not use the usual OpenSim service ports, please note that some network setups and ISPs will not allow HTTP to be served on port 80. It is usual to use an alternative port such as 8080 or a custom port in that case.

== Wifi URLs When Operational ==

* Sample grid: <nowiki>http://yourgridhostname:8002/wifi</nowiki>
* Sample standalone: <nowiki>http://yourstandalonehostname:9000/wifi</nowiki>
* Local standalone: <nowiki>http://localhost:9000/wifi</nowiki>

'''Examples'''

* Diva Tagus Test World (temporary August 2010): http://tagus.ics.uci.edu:9000/wifi

== Wifi Administrator Functions ==

=== Manage Users ===
[[Image:Openvue-Wifi-Example.jpg|300px|right|Example Wifi Entry Page]]
If authorisation is set to be on, you will receive an e-mail to the nominated admin account e-mail address if a user requests a new account and avatar creation. You can activate or delete new user creation requests. Users are notified of the activation via an e-mail to their nominated address.

You can also search for users and change their details. Give a space as a search term to select all avatars. Available are fields for "Level", "Flags" and "Title".
* Level = 0 is a normal user
* Level = 50 (default) is used to indicate a privileged user (e.g. who can set up new hypergrid linked regions)
* Level = 100 is a Wifi admin account user

You can manually reset a user's password by typiing into the password box and the nhitting the "Reset" button. Note that the user is '''NOT''' infromed of this password reset, so you must manually contact the user to communicate such a password change.

Note that the Wifi admin username/avatar is set in the Wifi configuration, and can be changed there. BUT.. '''once an admin always an admin'''. Well almost. If you change from one admin to another, the previous avatar still has administrator rights. You can remove Wifi administrator rights from an avatar by changing the "Level" of the user from 100 to the normal avatar level of 0 using the Manage Users facility in Wifi.

You can set an intermediate level for a '''privileged''' user which can be used to allow certain types of Wifi menu that a normal user will not see, but that are less than full admin user rights. A configurable parameter sets the '''Level''' above which this functions for a user (default 50).

=== Manage Regions ===

A facility to add '''LINK REGIONS''' is available in Wifi versions for OpenSim 0.7.1 onwards.

Administrators and other '''privileged''' users can also view the current set of '''LINKED REGIONS'''

=== Remote Console ===

A feature in Wifi versions for 0.7.1 onwards and available to administrators via the '''CONSOLE''' link if suitably enabled.

The WifiConsole uses OpenSim's REST console and thus the Robust server and any simulators must be started with parameter "-console rest". Furthermore, the configuration options "ConsoleUser" and "ConsolePass" must be set in section [Network] and the values of these options must match across all instances. Finally, for all region simulators (i.e. except for the Robust server), option "ConsoleAllowedOrigin" must be set to the same value as option "WebAddress" in section [WifiService] of the Robust configuration.

Please note that as at February 2011 the console in Wifi is not much more than a proof on concept in its current state. It has been tested on web browsers based on Mozilla (i.e. the Gecko Engine) only. Browsers using the WebKit engine do work somewhat, too, and IE has its own issues. The console also does not yet work with any interactive input, as necessary for creating a new region with "create region", for example.

Right now, there is no way to use this feature in a secure way because the values for "ConsoleUser" and "ConsolePass" are transmitted as clear text over the network. Please keep this in mind when using the console in Wifi.

== Diva Distribution ==

[[Image:Diva-Tagus-Wifi-Example-v2.jpg|300px|right|Example Wifi Entry Page]]

Wifi is included and enabled by default in the [[Diva Distribution]]:

* Documentation: http://wiki.github.com/diva/d2/wifi
* Blog Description: http://www.metaverseink.com/blog/
* Downloads and binary distribution: http://github.com/diva/d2/downloads
* Source Code: http://github.com/diva/diva-distribution/

Wifi

2011-05-15T10:39:31Z

Cliveg: /* PLEASE NOTE */

{{quicklinks}}
{{thirdparty}}
'''Wifi - A Simple Account Management Front-end'''

"Wifi" stands for "Web Interface For... I", and is an '''add-on''' module which is not a standard part of OpenSim. It is provided by Diva Canto and can be added to OpenSim 0.7 onwards.

== '''PLEASE NOTE''' ==
'''Some information on this page is out of date. Versions of Wifi are available for use with a ROBUST server grid implementation of OpenSim and as part of the standalone Diva distribution of OpenSimulator. Wifi is NOT designed to work with standalone implementations of OpenSim. Because of this certain information on this page may be misleading'''

For detailed and up to date information on Wifi please see Diva's documentation

----

== Introduction ==
'''


Wifi provides an embedded Web application for handling user registrations. Wifi is a set of components that can be loaded up by both standalone simulators and [[ROBUST]] servers.

Its features include:

* Account creation, optionally controlled by the administrator
* Configurable default avatars for new accounts
* Account updates by both users and administrator
* Account deletion by administrator
* Password recovery via email
* Simple management of user inventory 
* A welcome page which can be used as login page for the user's viewer.

Wifi has a few interesting properties that make it a good fit for small-to-medium OpenSimulator-based virtual worlds.

# It doesn’t require an additional web server; it’s all done with built-in OpenSimulator features.
# Using OpenSimulator features bring many technical benefits. These benefits aren't visible immediately, but it will show its value in the future. Unlike other Web apps that access the database directly, Wifi works by communicating with OpenSimulator directly. This means that any future changes to the OpenSimulator database structure, will not affect Wifi.
# Technically speaking, Wifi is a set of components that can be used by both standalone sims, as well as [[ROBUST]] (Grid) servers.

== Adding Wifi to your OpenSim Setup ==

'''Additions to Standard OpenSim Distribution (from 0.7 onwards)'''

=== Binary Approach ===

Obtain the latest Wifi module distribution zip from
http://github.com/diva/d2/downloads
and place the files as instructed in the equivalent locations in your OpenSim directory.

bin directory
* add bin/Diva.Wifi.dll
* add bin/Diva.Wifi.ScriptEngine.dll
* add bin/Diva.OpenSimServices.dll
* for standalones, also add bin/Diva.Modules.dll

Copy WifiPages directory and its contents to OpenSim top level directory.

doc directory
* add in doc/WIFI.txt

Copy over the WIFI related readme, release notes and licence text files.

For grids, edit Robust(.HG).ini in section [Startup] to add 8002/Diva.Wifi.dll:WifiServerConnector to <code>ServiceConnectors</code>.

For standalones, edit StandaloneCommon.ini in section [Modules] to add <code>WifiModule = true</code>.

Add a new section [WifiService] from example at http://github.com/diva/diva-distribution/blob/master/addon-modules/Wifi/Wifi.ini.example to Robust(.HG).ini (for grids) or StandaloneCommon.ini (for standalones).

=== Source Code Approach ===

Get Diva Distribution which contains the Wifi modules from
http://github.com/diva/diva-distribution/

== Setting Configuration Parameters for a Grid ==

The complete example file is here:
http://github.com/diva/diva-distribution/blob/master/addon-modules/Wifi/Wifi.ini.example

'''Additions to Robust.ini or Robust.HG.ini for Grids'''

<source lang="ini">[Startup]
ServiceConnectors = "8002/Diva.Wifi.dll:WifiServerConnector"
</source>

Note that it will be usual to specify the port number to be accessible outside your firewall (normally port 8002) rather than the default Network Port for internal inter-component OpenSim traffic (normally port 8003) which can be set to only be accessible within a firewall.

<source lang="ini">[WifiService]
GridName = "grid name"
LoginURL = "http://<hostname>:8002"
WebAddress = "http://<hostname>:8002"

;; The Wifi Administrator account
AdminFirst = "Wifi"
AdminLast = "Admin"
AdminEmail = "you@example.com"

;; Do you want to be able to control grid registrations?
AccountConfirmationRequired = false

;; Default avatars for new account registration
;; Syntax: AvatarAccount_<AvatarType> = "<FirstName> <LastName>"
;; Appearance and attachments are copied from avatar <FirstName> <LastName>.
AvatarAccount_Female = "Female Avatar"
AvatarAccount_Male = "Male Avatar"
AvatarAccount_Neutral = "Neutral Avatar"

;; Preselection for default avatar in new account registration
AvatarPreselection = "Neutral"

;; Variables for your mail server
;; Users will get email notifications from this account.
SmtpHost = "mail.example.com"
SmtpPort = "587"
SmtpUsername = "your_account_in_this_mail_server"
SmtpPassword = "your_password_in_this_mail_server"
</source>

== Setting Configuration Parameters for a Standalone ==

The complete example file is here:
http://github.com/diva/diva-distribution/blob/master/addon-modules/Wifi/Wifi.ini.example

'''Additions to config-include/StandaloneCommon.ini for Standalones'''

<source lang="ini">[Modules]
WifiModule = true

[WifiService]
GridName = "grid name"
LoginURL = "http://<hostname>:9000"
WebAddress = "http://<hostname>:9000"

;; The Wifi Administrator account
AdminFirst = "Wifi"
AdminLast = "Admin"
AdminEmail = "you@example.com"

;; Do you want to be able to control grid registrations?
AccountConfirmationRequired = false

;; Default avatars for new account registration
;; Syntax: AvatarAccount_<AvatarType> = "<FirstName> <LastName>"
;; Appearance and attachments are copied from avatar <FirstName> <LastName>.
AvatarAccount_Female = "Female Avatar"
AvatarAccount_Male = "Male Avatar"
AvatarAccount_Neutral = "Neutral Avatar"

;; Preselection for default avatar in new account registration
AvatarPreselection = "Neutral"

;; Variables for your mail server
;; Users will get email notifications from this account.
SmtpHost = "mail.example.com"
SmtpPort = "587"
SmtpUsername = "your_account_in_this_mail_server"
SmtpPassword = "your_password_in_this_mail_server"
</source>

== Configurable Default Avatars ==
[[Image:Openvue-avatars-male-female-neutral-2010-08-27.jpg|300px|right|Example Avatars]]
When users sign up, they can choose between default avatars. It's up to you to decide what these default avatars look like. Here is how you can configure them... Once your OpenSim is up and running, create accounts (using Wifi) with the names given in your configuration. With the above examples, these would be:
* Male Avatar
* Female Avatar
* Neutral Avatar

Then login to the world under each of those accounts, and set their appearances however you like. You can add prim attachments.

== Problems with HTTP ports ==

The port used for the Wifi HTTP service is configurable. Usually this will be 8002 for a grid and 9000 for a standalone unless you use custom ports.

For a standalone you can do this by adding the "port" line for the port to use for Wifi and other services to the [Network] section of OpenSim.ini

<source lang="ini">[Network]
port = 9000
</source>

Or for a grid specify a specific port (usually 8002) for the WifiServiceConnector in the ServiceConnectors list in the [Startup] section of Robust(.HG).ini

<source lang="ini">[Startup]
ServiceConnectors="............,8002/Diva.Wifi.dll:WifiServerConnector"
</source>

In either case, define the equivalent WebAddress in the [WifiService] section of your StandaloneCommon.ini or Robust(.HG).ini (or addon-modules/Wifi/config/Wifi.ini if used in future).

<source lang="ini">[WifiService]
WebAddress = "http://hostname:8002"
</source>

If you do not use the usual OpenSim service ports, please note that some network setups and ISPs will not allow HTTP to be served on port 80. It is usual to use an alternative port such as 8080 or a custom port in that case.

== Wifi URLs When Operational ==

* Sample grid: <nowiki>http://yourgridhostname:8002/wifi</nowiki>
* Sample standalone: <nowiki>http://yourstandalonehostname:9000/wifi</nowiki>
* Local standalone: <nowiki>http://localhost:9000/wifi</nowiki>

'''Examples'''

* Diva Tagus Test World (temporary August 2010): http://tagus.ics.uci.edu:9000/wifi

== Wifi Administrator Functions ==

=== Manage Users ===
[[Image:Openvue-Wifi-Example.jpg|300px|right|Example Wifi Entry Page]]
If authorisation is set to be on, you will receive an e-mail to the nominated admin account e-mail address if a user requests a new account and avatar creation. You can activate or delete new user creation requests. Users are notified of the activation via an e-mail to their nominated address.

You can also search for users and change their details. Give a space as a search term to select all avatars. Available are fields for "Level", "Flags" and "Title".
* Level = 0 is a normal user
* Level = 50 (default) is used to indicate a privileged user (e.g. who can set up new hypergrid linked regions)
* Level = 100 is a Wifi admin account user

You can manually reset a user's password by typiing into the password box and the nhitting the "Reset" button. Note that the user is '''NOT''' infromed of this password reset, so you must manually contact the user to communicate such a password change.

Note that the Wifi admin username/avatar is set in the Wifi configuration, and can be changed there. BUT.. '''once an admin always an admin'''. Well almost. If you change from one admin to another, the previous avatar still has administrator rights. You can remove Wifi administrator rights from an avatar by changing the "Level" of the user from 100 to the normal avatar level of 0 using the Manage Users facility in Wifi.

You can set an intermediate level for a '''privileged''' user which can be used to allow certain types of Wifi menu that a normal user will not see, but that are less than full admin user rights. A configurable parameter sets the '''Level''' above which this functions for a user (default 50).

=== Manage Regions ===

A facility to add '''LINK REGIONS''' is available in Wifi versions for OpenSim 0.7.1 onwards.

Administrators and other '''privileged''' users can also view the current set of '''LINKED REGIONS'''

=== Remote Console ===

A feature in Wifi versions for 0.7.1 onwards and available to administrators via the '''CONSOLE''' link if suitably enabled.

The WifiConsole uses OpenSim's REST console and thus the Robust server and any simulators must be started with parameter "-console rest". Furthermore, the configuration options "ConsoleUser" and "ConsolePass" must be set in section [Network] and the values of these options must match across all instances. Finally, for all region simulators (i.e. except for the Robust server), option "ConsoleAllowedOrigin" must be set to the same value as option "WebAddress" in section [WifiService] of the Robust configuration.

Please note that as at February 2011 the console in Wifi is not much more than a proof on concept in its current state. It has been tested on web browsers based on Mozilla (i.e. the Gecko Engine) only. Browsers using the WebKit engine do work somewhat, too, and IE has its own issues. The console also does not yet work with any interactive input, as necessary for creating a new region with "create region", for example.

Right now, there is no way to use this feature in a secure way because the values for "ConsoleUser" and "ConsolePass" are transmitted as clear text over the network. Please keep this in mind when using the console in Wifi.

== Diva Distribution ==

[[Image:Diva-Tagus-Wifi-Example-v2.jpg|300px|right|Example Wifi Entry Page]]

Wifi is included and enabled by default in the [[Diva Distribution]]:

* Documentation: http://wiki.github.com/diva/d2/wifi
* Blog Description: http://www.metaverseink.com/blog/
* Downloads and binary distribution: http://github.com/diva/d2/downloads
* Source Code: http://github.com/diva/diva-distribution/

Wifi

2011-05-15T10:30:55Z

Cliveg: /* Introduction */

{{quicklinks}}
{{thirdparty}}
'''Wifi - A Simple Account Management Front-end'''

"Wifi" stands for "Web Interface For... I", and is an '''add-on''' module which is not a standard part of OpenSim. It is provided by Diva Canto and can be added to OpenSim 0.7 onwards.

== '''PLEASE NOTE''' ==
'''Some information on this page is out of date. Versions of Wifi are available for use with a ROBUST grid implementation of OpenSim and as part of the DIVA standalone. Wifi is NOT designed to work with standalone implementations of OpenSim. Because of this certain information on this page may be misleading'''

----

== Introduction ==
'''


Wifi provides an embedded Web application for handling user registrations. Wifi is a set of components that can be loaded up by both standalone simulators and [[ROBUST]] servers.

Its features include:

* Account creation, optionally controlled by the administrator
* Configurable default avatars for new accounts
* Account updates by both users and administrator
* Account deletion by administrator
* Password recovery via email
* Simple management of user inventory 
* A welcome page which can be used as login page for the user's viewer.

Wifi has a few interesting properties that make it a good fit for small-to-medium OpenSimulator-based virtual worlds.

# It doesn’t require an additional web server; it’s all done with built-in OpenSimulator features.
# Using OpenSimulator features bring many technical benefits. These benefits aren't visible immediately, but it will show its value in the future. Unlike other Web apps that access the database directly, Wifi works by communicating with OpenSimulator directly. This means that any future changes to the OpenSimulator database structure, will not affect Wifi.
# Technically speaking, Wifi is a set of components that can be used by both standalone sims, as well as [[ROBUST]] (Grid) servers.

== Adding Wifi to your OpenSim Setup ==

'''Additions to Standard OpenSim Distribution (from 0.7 onwards)'''

=== Binary Approach ===

Obtain the latest Wifi module distribution zip from
http://github.com/diva/d2/downloads
and place the files as instructed in the equivalent locations in your OpenSim directory.

bin directory
* add bin/Diva.Wifi.dll
* add bin/Diva.Wifi.ScriptEngine.dll
* add bin/Diva.OpenSimServices.dll
* for standalones, also add bin/Diva.Modules.dll

Copy WifiPages directory and its contents to OpenSim top level directory.

doc directory
* add in doc/WIFI.txt

Copy over the WIFI related readme, release notes and licence text files.

For grids, edit Robust(.HG).ini in section [Startup] to add 8002/Diva.Wifi.dll:WifiServerConnector to <code>ServiceConnectors</code>.

For standalones, edit StandaloneCommon.ini in section [Modules] to add <code>WifiModule = true</code>.

Add a new section [WifiService] from example at http://github.com/diva/diva-distribution/blob/master/addon-modules/Wifi/Wifi.ini.example to Robust(.HG).ini (for grids) or StandaloneCommon.ini (for standalones).

=== Source Code Approach ===

Get Diva Distribution which contains the Wifi modules from
http://github.com/diva/diva-distribution/

== Setting Configuration Parameters for a Grid ==

The complete example file is here:
http://github.com/diva/diva-distribution/blob/master/addon-modules/Wifi/Wifi.ini.example

'''Additions to Robust.ini or Robust.HG.ini for Grids'''

<source lang="ini">[Startup]
ServiceConnectors = "8002/Diva.Wifi.dll:WifiServerConnector"
</source>

Note that it will be usual to specify the port number to be accessible outside your firewall (normally port 8002) rather than the default Network Port for internal inter-component OpenSim traffic (normally port 8003) which can be set to only be accessible within a firewall.

<source lang="ini">[WifiService]
GridName = "grid name"
LoginURL = "http://<hostname>:8002"
WebAddress = "http://<hostname>:8002"

;; The Wifi Administrator account
AdminFirst = "Wifi"
AdminLast = "Admin"
AdminEmail = "you@example.com"

;; Do you want to be able to control grid registrations?
AccountConfirmationRequired = false

;; Default avatars for new account registration
;; Syntax: AvatarAccount_<AvatarType> = "<FirstName> <LastName>"
;; Appearance and attachments are copied from avatar <FirstName> <LastName>.
AvatarAccount_Female = "Female Avatar"
AvatarAccount_Male = "Male Avatar"
AvatarAccount_Neutral = "Neutral Avatar"

;; Preselection for default avatar in new account registration
AvatarPreselection = "Neutral"

;; Variables for your mail server
;; Users will get email notifications from this account.
SmtpHost = "mail.example.com"
SmtpPort = "587"
SmtpUsername = "your_account_in_this_mail_server"
SmtpPassword = "your_password_in_this_mail_server"
</source>

== Setting Configuration Parameters for a Standalone ==

The complete example file is here:
http://github.com/diva/diva-distribution/blob/master/addon-modules/Wifi/Wifi.ini.example

'''Additions to config-include/StandaloneCommon.ini for Standalones'''

<source lang="ini">[Modules]
WifiModule = true

[WifiService]
GridName = "grid name"
LoginURL = "http://<hostname>:9000"
WebAddress = "http://<hostname>:9000"

;; The Wifi Administrator account
AdminFirst = "Wifi"
AdminLast = "Admin"
AdminEmail = "you@example.com"

;; Do you want to be able to control grid registrations?
AccountConfirmationRequired = false

;; Default avatars for new account registration
;; Syntax: AvatarAccount_<AvatarType> = "<FirstName> <LastName>"
;; Appearance and attachments are copied from avatar <FirstName> <LastName>.
AvatarAccount_Female = "Female Avatar"
AvatarAccount_Male = "Male Avatar"
AvatarAccount_Neutral = "Neutral Avatar"

;; Preselection for default avatar in new account registration
AvatarPreselection = "Neutral"

;; Variables for your mail server
;; Users will get email notifications from this account.
SmtpHost = "mail.example.com"
SmtpPort = "587"
SmtpUsername = "your_account_in_this_mail_server"
SmtpPassword = "your_password_in_this_mail_server"
</source>

== Configurable Default Avatars ==
[[Image:Openvue-avatars-male-female-neutral-2010-08-27.jpg|300px|right|Example Avatars]]
When users sign up, they can choose between default avatars. It's up to you to decide what these default avatars look like. Here is how you can configure them... Once your OpenSim is up and running, create accounts (using Wifi) with the names given in your configuration. With the above examples, these would be:
* Male Avatar
* Female Avatar
* Neutral Avatar

Then login to the world under each of those accounts, and set their appearances however you like. You can add prim attachments.

== Problems with HTTP ports ==

The port used for the Wifi HTTP service is configurable. Usually this will be 8002 for a grid and 9000 for a standalone unless you use custom ports.

For a standalone you can do this by adding the "port" line for the port to use for Wifi and other services to the [Network] section of OpenSim.ini

<source lang="ini">[Network]
port = 9000
</source>

Or for a grid specify a specific port (usually 8002) for the WifiServiceConnector in the ServiceConnectors list in the [Startup] section of Robust(.HG).ini

<source lang="ini">[Startup]
ServiceConnectors="............,8002/Diva.Wifi.dll:WifiServerConnector"
</source>

In either case, define the equivalent WebAddress in the [WifiService] section of your StandaloneCommon.ini or Robust(.HG).ini (or addon-modules/Wifi/config/Wifi.ini if used in future).

<source lang="ini">[WifiService]
WebAddress = "http://hostname:8002"
</source>

If you do not use the usual OpenSim service ports, please note that some network setups and ISPs will not allow HTTP to be served on port 80. It is usual to use an alternative port such as 8080 or a custom port in that case.

== Wifi URLs When Operational ==

* Sample grid: <nowiki>http://yourgridhostname:8002/wifi</nowiki>
* Sample standalone: <nowiki>http://yourstandalonehostname:9000/wifi</nowiki>
* Local standalone: <nowiki>http://localhost:9000/wifi</nowiki>

'''Examples'''

* Diva Tagus Test World (temporary August 2010): http://tagus.ics.uci.edu:9000/wifi

== Wifi Administrator Functions ==

=== Manage Users ===
[[Image:Openvue-Wifi-Example.jpg|300px|right|Example Wifi Entry Page]]
If authorisation is set to be on, you will receive an e-mail to the nominated admin account e-mail address if a user requests a new account and avatar creation. You can activate or delete new user creation requests. Users are notified of the activation via an e-mail to their nominated address.

You can also search for users and change their details. Give a space as a search term to select all avatars. Available are fields for "Level", "Flags" and "Title".
* Level = 0 is a normal user
* Level = 50 (default) is used to indicate a privileged user (e.g. who can set up new hypergrid linked regions)
* Level = 100 is a Wifi admin account user

You can manually reset a user's password by typiing into the password box and the nhitting the "Reset" button. Note that the user is '''NOT''' infromed of this password reset, so you must manually contact the user to communicate such a password change.

Note that the Wifi admin username/avatar is set in the Wifi configuration, and can be changed there. BUT.. '''once an admin always an admin'''. Well almost. If you change from one admin to another, the previous avatar still has administrator rights. You can remove Wifi administrator rights from an avatar by changing the "Level" of the user from 100 to the normal avatar level of 0 using the Manage Users facility in Wifi.

You can set an intermediate level for a '''privileged''' user which can be used to allow certain types of Wifi menu that a normal user will not see, but that are less than full admin user rights. A configurable parameter sets the '''Level''' above which this functions for a user (default 50).

=== Manage Regions ===

A facility to add '''LINK REGIONS''' is available in Wifi versions for OpenSim 0.7.1 onwards.

Administrators and other '''privileged''' users can also view the current set of '''LINKED REGIONS'''

=== Remote Console ===

A feature in Wifi versions for 0.7.1 onwards and available to administrators via the '''CONSOLE''' link if suitably enabled.

The WifiConsole uses OpenSim's REST console and thus the Robust server and any simulators must be started with parameter "-console rest". Furthermore, the configuration options "ConsoleUser" and "ConsolePass" must be set in section [Network] and the values of these options must match across all instances. Finally, for all region simulators (i.e. except for the Robust server), option "ConsoleAllowedOrigin" must be set to the same value as option "WebAddress" in section [WifiService] of the Robust configuration.

Please note that as at February 2011 the console in Wifi is not much more than a proof on concept in its current state. It has been tested on web browsers based on Mozilla (i.e. the Gecko Engine) only. Browsers using the WebKit engine do work somewhat, too, and IE has its own issues. The console also does not yet work with any interactive input, as necessary for creating a new region with "create region", for example.

Right now, there is no way to use this feature in a secure way because the values for "ConsoleUser" and "ConsolePass" are transmitted as clear text over the network. Please keep this in mind when using the console in Wifi.

== Diva Distribution ==

[[Image:Diva-Tagus-Wifi-Example-v2.jpg|300px|right|Example Wifi Entry Page]]

Wifi is included and enabled by default in the [[Diva Distribution]]:

* Documentation: http://wiki.github.com/diva/d2/wifi
* Blog Description: http://www.metaverseink.com/blog/
* Downloads and binary distribution: http://github.com/diva/d2/downloads
* Source Code: http://github.com/diva/diva-distribution/

Wifi

2011-05-15T10:26:14Z

Cliveg: /* Introduction */

{{quicklinks}}
{{thirdparty}}
'''Wifi - A Simple Account Management Front-end'''

"Wifi" stands for "Web Interface For... I", and is an '''add-on''' module which is not a standard part of OpenSim. It is provided by Diva Canto and can be added to OpenSim 0.7 onwards.

== Introduction ==
'''
PLEASE NOTE: Information on this page is out of date. Versions of Wifi are available for use with a ROBUST grid implementation of OpenSim and as part of the DIVA standalone. Wifi is NOT designed to work with standalone implementations of OpenSim. Because of this information on this page may be misleading'''

----


Wifi provides an embedded Web application for handling user registrations. Wifi is a set of components that can be loaded up by both standalone simulators and [[ROBUST]] servers.

Its features include:

* Account creation, optionally controlled by the administrator
* Configurable default avatars for new accounts
* Account updates by both users and administrator
* Account deletion by administrator
* Password recovery via email
* Simple management of user inventory 
* A welcome page which can be used as login page for the user's viewer.

Wifi has a few interesting properties that make it a good fit for small-to-medium OpenSimulator-based virtual worlds.

# It doesn’t require an additional web server; it’s all done with built-in OpenSimulator features.
# Using OpenSimulator features bring many technical benefits. These benefits aren't visible immediately, but it will show its value in the future. Unlike other Web apps that access the database directly, Wifi works by communicating with OpenSimulator directly. This means that any future changes to the OpenSimulator database structure, will not affect Wifi.
# Technically speaking, Wifi is a set of components that can be used by both standalone sims, as well as [[ROBUST]] (Grid) servers.

== Adding Wifi to your OpenSim Setup ==

'''Additions to Standard OpenSim Distribution (from 0.7 onwards)'''

=== Binary Approach ===

Obtain the latest Wifi module distribution zip from
http://github.com/diva/d2/downloads
and place the files as instructed in the equivalent locations in your OpenSim directory.

bin directory
* add bin/Diva.Wifi.dll
* add bin/Diva.Wifi.ScriptEngine.dll
* add bin/Diva.OpenSimServices.dll
* for standalones, also add bin/Diva.Modules.dll

Copy WifiPages directory and its contents to OpenSim top level directory.

doc directory
* add in doc/WIFI.txt

Copy over the WIFI related readme, release notes and licence text files.

For grids, edit Robust(.HG).ini in section [Startup] to add 8002/Diva.Wifi.dll:WifiServerConnector to <code>ServiceConnectors</code>.

For standalones, edit StandaloneCommon.ini in section [Modules] to add <code>WifiModule = true</code>.

Add a new section [WifiService] from example at http://github.com/diva/diva-distribution/blob/master/addon-modules/Wifi/Wifi.ini.example to Robust(.HG).ini (for grids) or StandaloneCommon.ini (for standalones).

=== Source Code Approach ===

Get Diva Distribution which contains the Wifi modules from
http://github.com/diva/diva-distribution/

== Setting Configuration Parameters for a Grid ==

The complete example file is here:
http://github.com/diva/diva-distribution/blob/master/addon-modules/Wifi/Wifi.ini.example

'''Additions to Robust.ini or Robust.HG.ini for Grids'''

<source lang="ini">[Startup]
ServiceConnectors = "8002/Diva.Wifi.dll:WifiServerConnector"
</source>

Note that it will be usual to specify the port number to be accessible outside your firewall (normally port 8002) rather than the default Network Port for internal inter-component OpenSim traffic (normally port 8003) which can be set to only be accessible within a firewall.

<source lang="ini">[WifiService]
GridName = "grid name"
LoginURL = "http://<hostname>:8002"
WebAddress = "http://<hostname>:8002"

;; The Wifi Administrator account
AdminFirst = "Wifi"
AdminLast = "Admin"
AdminEmail = "you@example.com"

;; Do you want to be able to control grid registrations?
AccountConfirmationRequired = false

;; Default avatars for new account registration
;; Syntax: AvatarAccount_<AvatarType> = "<FirstName> <LastName>"
;; Appearance and attachments are copied from avatar <FirstName> <LastName>.
AvatarAccount_Female = "Female Avatar"
AvatarAccount_Male = "Male Avatar"
AvatarAccount_Neutral = "Neutral Avatar"

;; Preselection for default avatar in new account registration
AvatarPreselection = "Neutral"

;; Variables for your mail server
;; Users will get email notifications from this account.
SmtpHost = "mail.example.com"
SmtpPort = "587"
SmtpUsername = "your_account_in_this_mail_server"
SmtpPassword = "your_password_in_this_mail_server"
</source>

== Setting Configuration Parameters for a Standalone ==

The complete example file is here:
http://github.com/diva/diva-distribution/blob/master/addon-modules/Wifi/Wifi.ini.example

'''Additions to config-include/StandaloneCommon.ini for Standalones'''

<source lang="ini">[Modules]
WifiModule = true

[WifiService]
GridName = "grid name"
LoginURL = "http://<hostname>:9000"
WebAddress = "http://<hostname>:9000"

;; The Wifi Administrator account
AdminFirst = "Wifi"
AdminLast = "Admin"
AdminEmail = "you@example.com"

;; Do you want to be able to control grid registrations?
AccountConfirmationRequired = false

;; Default avatars for new account registration
;; Syntax: AvatarAccount_<AvatarType> = "<FirstName> <LastName>"
;; Appearance and attachments are copied from avatar <FirstName> <LastName>.
AvatarAccount_Female = "Female Avatar"
AvatarAccount_Male = "Male Avatar"
AvatarAccount_Neutral = "Neutral Avatar"

;; Preselection for default avatar in new account registration
AvatarPreselection = "Neutral"

;; Variables for your mail server
;; Users will get email notifications from this account.
SmtpHost = "mail.example.com"
SmtpPort = "587"
SmtpUsername = "your_account_in_this_mail_server"
SmtpPassword = "your_password_in_this_mail_server"
</source>

== Configurable Default Avatars ==
[[Image:Openvue-avatars-male-female-neutral-2010-08-27.jpg|300px|right|Example Avatars]]
When users sign up, they can choose between default avatars. It's up to you to decide what these default avatars look like. Here is how you can configure them... Once your OpenSim is up and running, create accounts (using Wifi) with the names given in your configuration. With the above examples, these would be:
* Male Avatar
* Female Avatar
* Neutral Avatar

Then login to the world under each of those accounts, and set their appearances however you like. You can add prim attachments.

== Problems with HTTP ports ==

The port used for the Wifi HTTP service is configurable. Usually this will be 8002 for a grid and 9000 for a standalone unless you use custom ports.

For a standalone you can do this by adding the "port" line for the port to use for Wifi and other services to the [Network] section of OpenSim.ini

<source lang="ini">[Network]
port = 9000
</source>

Or for a grid specify a specific port (usually 8002) for the WifiServiceConnector in the ServiceConnectors list in the [Startup] section of Robust(.HG).ini

<source lang="ini">[Startup]
ServiceConnectors="............,8002/Diva.Wifi.dll:WifiServerConnector"
</source>

In either case, define the equivalent WebAddress in the [WifiService] section of your StandaloneCommon.ini or Robust(.HG).ini (or addon-modules/Wifi/config/Wifi.ini if used in future).

<source lang="ini">[WifiService]
WebAddress = "http://hostname:8002"
</source>

If you do not use the usual OpenSim service ports, please note that some network setups and ISPs will not allow HTTP to be served on port 80. It is usual to use an alternative port such as 8080 or a custom port in that case.

== Wifi URLs When Operational ==

* Sample grid: <nowiki>http://yourgridhostname:8002/wifi</nowiki>
* Sample standalone: <nowiki>http://yourstandalonehostname:9000/wifi</nowiki>
* Local standalone: <nowiki>http://localhost:9000/wifi</nowiki>

'''Examples'''

* Diva Tagus Test World (temporary August 2010): http://tagus.ics.uci.edu:9000/wifi

== Wifi Administrator Functions ==

=== Manage Users ===
[[Image:Openvue-Wifi-Example.jpg|300px|right|Example Wifi Entry Page]]
If authorisation is set to be on, you will receive an e-mail to the nominated admin account e-mail address if a user requests a new account and avatar creation. You can activate or delete new user creation requests. Users are notified of the activation via an e-mail to their nominated address.

You can also search for users and change their details. Give a space as a search term to select all avatars. Available are fields for "Level", "Flags" and "Title".
* Level = 0 is a normal user
* Level = 50 (default) is used to indicate a privileged user (e.g. who can set up new hypergrid linked regions)
* Level = 100 is a Wifi admin account user

You can manually reset a user's password by typiing into the password box and the nhitting the "Reset" button. Note that the user is '''NOT''' infromed of this password reset, so you must manually contact the user to communicate such a password change.

Note that the Wifi admin username/avatar is set in the Wifi configuration, and can be changed there. BUT.. '''once an admin always an admin'''. Well almost. If you change from one admin to another, the previous avatar still has administrator rights. You can remove Wifi administrator rights from an avatar by changing the "Level" of the user from 100 to the normal avatar level of 0 using the Manage Users facility in Wifi.

You can set an intermediate level for a '''privileged''' user which can be used to allow certain types of Wifi menu that a normal user will not see, but that are less than full admin user rights. A configurable parameter sets the '''Level''' above which this functions for a user (default 50).

=== Manage Regions ===

A facility to add '''LINK REGIONS''' is available in Wifi versions for OpenSim 0.7.1 onwards.

Administrators and other '''privileged''' users can also view the current set of '''LINKED REGIONS'''

=== Remote Console ===

A feature in Wifi versions for 0.7.1 onwards and available to administrators via the '''CONSOLE''' link if suitably enabled.

The WifiConsole uses OpenSim's REST console and thus the Robust server and any simulators must be started with parameter "-console rest". Furthermore, the configuration options "ConsoleUser" and "ConsolePass" must be set in section [Network] and the values of these options must match across all instances. Finally, for all region simulators (i.e. except for the Robust server), option "ConsoleAllowedOrigin" must be set to the same value as option "WebAddress" in section [WifiService] of the Robust configuration.

Please note that as at February 2011 the console in Wifi is not much more than a proof on concept in its current state. It has been tested on web browsers based on Mozilla (i.e. the Gecko Engine) only. Browsers using the WebKit engine do work somewhat, too, and IE has its own issues. The console also does not yet work with any interactive input, as necessary for creating a new region with "create region", for example.

Right now, there is no way to use this feature in a secure way because the values for "ConsoleUser" and "ConsolePass" are transmitted as clear text over the network. Please keep this in mind when using the console in Wifi.

== Diva Distribution ==

[[Image:Diva-Tagus-Wifi-Example-v2.jpg|300px|right|Example Wifi Entry Page]]

Wifi is included and enabled by default in the [[Diva Distribution]]:

* Documentation: http://wiki.github.com/diva/d2/wifi
* Blog Description: http://www.metaverseink.com/blog/
* Downloads and binary distribution: http://github.com/diva/d2/downloads
* Source Code: http://github.com/diva/diva-distribution/

Build Instructions

2009-10-24T10:20:43Z

Cliveg:

{{Template:Quicklinks}}

[[Category:Users]]
This page covers building OpenSim from source code on multiple platforms. Please help us keep this page up to date as the project progresses.

==Download OpenSim ==
Check out the [[Download]] page for instructions on obtaining an OpenSim source release.

==MS Windows==

OpenSim requires either the .Net framework version 2.0, or the latest Mono. It supports the following compilers:
* [http://msdn2.microsoft.com/en-us/express/aa700756.aspx Microsoft Visual C# Express Edition] (note: not Visual C++)
* [http://www.mono-project.com/ mono]

Additional note: If you like IDE's you will need C# express 2008 or VS 2008.

Additional note: Microsoft C# Express v9 may install .Net 3.5 with resultant path error.
# To avoid install .Net framework version 2.0

Additional note: It is possible to develop on Windows Vista 64 bits with the following tweaks:
# Select OpenSim project properties from solution and choose platform to be x86. Rebuild solution.
# Select OpenSim.exe properties under solution bin folder and choose windows xp sp 2 compatibility mode + run as administrator.

=== Building ===

* In the top-level directory, run the '<tt>runprebuild.bat</tt>' file. This will create a VS2008 solution file, a nant build file and a '<tt>compile.bat</tt>' file.

* Open the resulting sln file with visual studio and build it there, or
* Run the '<tt>compile.bat</tt>' file. This will build the executable using MSBuild.
* if you prefer to use nant, run nant in the same top-level directory. This will build the executables.

If you don't care about physics (walking on prims, etc), ignore the rest of this section.

=== Running ===

Recent versions of OpenSim come without an <tt>OpenSim.ini</tt> file. Copy the <tt>OpenSim.ini.example</tt> file to <tt>OpenSim.ini</tt> before making any changes.

Double-click on the <tt>OpenSim.exe</tt> executable file in the <tt>bin</tt> directory. This will start up OpenSim in standalone mode.

The debugger in VS2005 C# may be used to step through the code. For those that use a Cygwin shell, you may find that one or more dll's have permissions that cause problems running. Most find that a "<tt>chmod 777 *</tt>" from the <tt>bin</tt> directory solves this.

Physics can be invoked by adding the appropriate line to the [Startup] section of <tt>OpenSim.ini</tt>. For ODE, that would be:

physics = OpenDynamicsEngine

You can also add a command line option to a shortcut, or run from a command prompt with:

-physics=OpenDynamicsEngine

'''''Windows Vista'''''

Some people have reported that to run on Windows Vista, you must first disable Windows Firewall. Under the new "Start" button of Vista, select "Control panel". Then double-click "Windows Firewall". In the window that pops up, on the left column, select "Turn Windows Firewall on or off". You will have to give permission for this to run, then select the option "Off (not recommended)". Click "OK" and exit from the Windows Firewall window.

If you have McAfee SecurityCenter, see the description below.

Once all the security features are disabled, right click on <tt>OpenSim.exe</tt> and select "Run as administrator". This will pop up a window asking permission, select "Allow". Your OpenSim server should run in a DOS-like window and accept connections.

'''''McAfee Security'''''

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.

''Disable firewall''

Open McAfee SecurityCenter. Select "Internet & 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".

''Enable <tt>OpenSim.exe</tt> to open ports''

Open McAfee SecurityCenter. Select "Internet & 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.

Finally, select "OK" and exit the McAfee SecurityCenter window.

==Linux/Mac OS X/FreeBSD==

The easiest plaform to get running on the Linux side is Ubuntu 8.10, 32bit. This is what most of the developers running Linux use. If you are looking for the quick path, start there.

=== Ubuntu 8.04 / 8.10 / 9.04 / 9.10 ===

For Ubuntu users on older distributions (7.10, 8.04, etc.) '''you need''' to upgrade your mono to at least 1.9.1. Mono 2.2 is currently the preferred version to run OpenSim with. (** NOTE ** - recent builds seem to prefer 2.4?)

You can use the built in packages for mono. However, for better performance, you may want to [http://xyzzyxyzzy.net/2008/05/08/updated-mono-build-script-for-hardy-heron-and-mono-191/ upgrade mono to 1.9.1] ([http://tempvariable.blogspot.com/2008/04/installing-mono-191-on-ubuntu-804-hardy.html Other simple method])

sudo apt-get install subversion nant mono-gmcs libmono-microsoft8.0-cil \
libmono-system-runtime2.0-cil libgdiplus libmono-i18n2.0-cil libmono-oracle2.0-cil
[[Download]] opensim
cd opensim
./runprebuild.sh
nant

To upgrade the Mono version to the latest stable build Mono 2.0.1, read this page [[Build Instructions/Ubuntu-Mono-2.0.1 | Ubuntu on Mono 2.0.1]]

=== openSUSE 10.3/11/11.1 ===

Install an openSUSE 11.1, 11 or 10.3 with its default options, add the online repositories
when finished installing do an online update with all the latest packages.

In yast install these packages, for running Opensim in standalone mode.
(there is a slight diffrence between 10.3 and 11/11.1 but following should be same)
subversion
nant
mono-jscript
- check that mono-core is installed

just in case you do not already have it installed

sudo zypper install mono-data-oracle

A tip for OpenSuSE 11.1 users - you can install packages from the command line using the 'zypper' tool. For example, to install 'nant', use this command:

sudo zypper install nant

If you just want to use SQLite then jump to last section
within this post.

* Optional mysql - for Opensim running in Grid mode:
Install these mysql packages via yast
mysql
mysql-client
mysql-administrator
mysql-gui-tools
mysql-query-browser

(note that selecting mysql in the Yast2 Installer will select the other packages automatically)

Before building create the mysql database.
/etc/init.d/mysql start
mysql -u root -p -h localhost
(when asked for password just hit enter)

mysql> create database opensim;
mysql> use opensim;
mysql> create user 'opensim'@'localhost' identified by 'thePassword';
mysql> grant all on *.* to 'opensim'@'localhost';
mysql> quit

*note that the '''grant all''' command may differ if you're adding the opensim database to an existing mysql installation.

On current builds set the connection string inside bin/OpenSim.ini after coppying the OpenSim.ini.example file.
If you are changing to MySQL from SQLite, the connection string for mysql also exists in the bin/Region/*xml files.
* It is '''important''' to remember this if you start out using the built-in SQLite database engine.

Build after installation of above in bash terminal. I save it in /opt

su -
cd /opt
[[Download]] opensim
cd opensim
./runprebuild.sh
nant

Or, if you have a current (0.6+), you can simply execute:

make

After this you should be able to continue on starting the diffrent Servers, look in the mysql-config section,or
just run your OpenSim as a Standalone. By - eagleFX

=== Mac OS X 10.5/10.4 ===
* OpenSim is now working on PowerPC Macs! Thanks to DrScofield and those who helped him. Current nightly builds for PowerPC are not working, not sure about Intel so use the 0.5 Build. OpenSim works on Intel Macs. I'm testing on PowerBook G4. Tested these step on 10.5, but not 10.4 but should work --[[User:Mokele|Mokele]] 22:36, 14 February 2008 (PST) (Works on iMac G5 with OS 10.4.11, including expanding to local grid mode. --[[User:Magnuz|Magnuz]] 2008-12-15 10:50 (CET))
* Install XCode Developers Tools from DVD/CD Installation Disk or download from http://developer.apple.com/. You have to create an Apple account to access the downloads if you don't have an Apple account.
* Install X11 for 10.4 from the Optional Install from the DVD/CD Installation Disk. X11 for 10.5 is installed by default.
* Install Mono 1.2.5 from http://ftp.novell.com/pub/mono/archive/1.2.5/macos-10-universal/5/MonoFramework-1.2.5_5.macos10.novell.universal.dmg (The more recent releases Mono 1.2.6, 1.9.1 and 2.0.1 do not appear to work with these installation instructions. --[[User:Magnuz|Magnuz]] 2008-12-14 15:56 (CET)) and in Terminal or X11 edit the .profile file and add the following line:
export PKG_CONFIG_PATH="/Library/Frameworks/Mono.framework/Versions/Current/lib/pkgconfig/:${PKG_CONFIG_PATH}"
* Compile OpenSim
svn co http://opensimulator.org/svn/opensim/tags/0.5.0-release opensim
cd opensim
./runprebuild.sh
nant

* Download and Compile libopenjpeg-libsl-2.1.2.0.dylib and libsecondlife.dll
* libopenjpeg-libsl-2.1.2.0.dylib:
svn co http://opensimulator.org/svn/opensim-libs/old/libsl1550 opensim-libs
cd opensim-libs/openjpeg-libsl
make -f Makefile.osx
cp libopenjpeg-libsl-2.1.2.0.dylib ../../bin
* Note: The Makefile that creates the libopenjpeg-libsl-2.1.2.0.so does not compile on PowerPC, but works properly on Intel Macs. Looks like a gcc issue with compile options. (It appears to work on iMac G5 with OS X 10.4.11. --[[User:Magnuz|Magnuz]] 2008-12-14 15:55 (CET))

* libsecondlife.dll: (for PowerPC Only, see details on this step [http://xyzzyxyzzy.net/2008/02/12/installing-opensim-on-powerpcor-of-eggs-and-virtual-worlds installing OpenSim on PowerPC…or: of eggs and virtual worlds])
cd .. (back into opensim-libs)
nant
cp bin/libsecondlife.dll ../bin

* Edit the libsecondlife.dll.config (PowerPC Only). Remove the cpu="x86" tag in the last dllmap line.

Here is what worked for me (OS X 10.5.7, Intel):

* make sure you have X11 installed
* grab the Apple Dev Tools from [http://developer.apple.com/]
* install Mono Framework 2.4 from [http://www.go-mono.com/mono-downloads/download.html]
* Get OpenSim source:
svn co http://opensimulator.org/svn/opensim/tags/0.6.5-post-fixes opensim
* Compile OpenSim:
cd opensim
./runprebuild.sh
nant
--[[User:Kusako|Kusako]] 08:06, 19 June 2009 (UTC)

Here is what worked for me (OS X 10.5.7 and 10.6, Intel) on (8/9/09):

* make sure you have X11 installed
* Very important to grab the latest Apple Dev Tools (3.2.1 on 8/9/09) (from [http://developer.apple.com/] - You will need a developer account, it is free.
* install Mono Framework 2.4 (version 2.4.2.3 on 8/9/09) from [http://www.go-mono.com/mono-downloads/download.html]
* install Mac Ports from [http://www.macports.org/]
* Mac Ports should update its packages on install, but to be safe, type the following at the Terminal:
sudo port -v selfupdate
* Use mac ports to install nant. (This should pull in everything you need. I think this will also try to install mono, but since I already had it installed, that errored on me. Don't worry about it though, it should install everything else you need.) At the Terminal type:
sudo port install nant

* Get OpenSim source. I downloaded 0.6.6 from [http://opensimulator.org/wiki/Download]
* Uncompress the download.
* Compile OpenSim:
cd opensim
./runprebuild.sh
nant

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

'''Summary''':

*Run OpenSim0.6.6Setup.exe and install OpenSim in Windows
*Run OpenSim.exe and enter default values - record them!
*Shutdown simulator (command: shutdown)
*Create default.xml with copy of above
*Change values in default.xml with recoded values
*Be sure default.xml be in main directory (same with OpenSim.ini)
*Run again OpenSim.exe
*Connect with viewer
--[[User:thart|thart]] 12:00, 10 October 2009 (UTC)

=== FreeBSD 6.2 ===
su
cd /usr/ports/devel/subversion/ && make install clean (you may also need to rebuild apr-svn if this step fails)
cd /usr/ports/lang/mono/ && make install clean
cd /usr/ports/devel/nant/ && make install clean
cd /usr/ports/databases/sqlite3/ && make install clean
cd /usr/ports/x11-toolkits/libgdiplus/ && make install clean
cd /opensim/installation/directory/
[[Download]] opensim
cd opensim
./runprebuild.sh
nant

Note: [http://opensimulator.org/wiki/OpenSim:FAQ#System.DllNotFoundException:_..2Flibopenjpeg-libsl-2.1.2.0.so|Follow the instructions on the FAQ to fix the]
"System.DllNotFoundException: ./libopenjpeg-libsl-2.1.2.0.so" issue, but use "gmake" instead of "make"

For ODE Physics you must do the following:
cd /usr/ports/graphics/libGL/ && make install clean
cd /usr/ports/graphics/libGLU/ && make install clean
cd /opensim/installation/directory/
svn co http://opensimulator.org/svn/opensim-libs/trunk opensim-libs
cd opensim-libs/unmanaged/OpenDynamicsEngine2/
sh autogen.sh
./configure --enable-shared --enable-release --disable-demos
make
mv ./ode/src/.libs/libode.so /opensim/installation/directory/opensim/bin/

=== RedHat Enterprise Linux 4 ===
sudo vi /etc/yum.repos.d/mono.repo

[mono]
name=Mono for rhel-4-i386 (stable)
baseurl=http://ftp.novell.com/pub/mono/download-stable/rhel-4-i386/
enabled=1
gpgcheck=0

sudo yum install mono-complete monodoc-core nant
[[Download]] opensim
cd opensim
./runprebuild.sh
nant

=== RedHat Enterprise Linux 5 ===

The instructions below also work on other RedHat Linux flavors such as CentOS or maybe Fedora.

1. Put the [http://download.opensuse.org/repositories/Mono/RHEL_5/Mono.repo Mono.repo] file in the /etc/yum.repo.d/ directory:
$ sudo su -
$ cd /etc/yum.repos.d/
$ wget http://download.opensuse.org/repositories/Mono/RHEL_5/Mono.repo
Naturally use the most [http://download.opensuse.org/repositories/Mono up-to-date link for your distribution].

2. Install Mono and related tools with yum:
$ yum install mono nant mono-jscript mono-nunit
Make sure to use nunit-console2 to run your tests.

=== Fedora 5 ===
* I needed to build latest mono and nant from sources to build OpenSim successfully, the ones available in yum repository didn't work so I had to uninstall and build and configure the packages.

For detailed instructions go [http://ruakuu.blogspot.com/2008/06/installing-and-configuring-opensim-on.html here]

=== Debian 4 ===

For detailed instructions please see [[Debian 4 Build Instructions]]

=== CentOS 5.2 32bit ===

For detailed instructions please see [[CentOS 5.2 Build Instructions]]

=== CentOS 5.3 32bit ===

For detailed installation and configuration instructions please see this [http://www.linuxtraining.org.uk/blogger4.html blog]

=== 64bit ===
Please note that only 32bit binaries are provided in the bin/ directory of subversion. If you want to use 64bit, you'll need to rebuild these shared objects. See [[Installing and running on x86-64]]

=== Physics (Open Dynamics Engine ODE) ===
As installed from svn, ODE will work on most 32 bit platforms. If you get an ODE-related crash, and/or a <i>libode.so not found</i> type of error, you will need to build libode from source.

Remove <tt>libode.so</tt> from the <tt>./bin</tt> folder. (Note that subsequent svn updates may replace it again; best fix is to copy your built <tt>libode.so</tt> to <tt>bin</tt>). Do NOT remove <tt>ode.net.dll</tt>! Download the latest source from:

svn co http://opensimulator.org/svn/opensim-libs/trunk/unmanaged/OpenDynamicsEngine

OpenSim requires a couple of patches on top of ODE which are not yet included upstream. When compiling, make sure to use the following configure options:

--with-trimesh=gimpact
--enable-shared

Make sure the configure script confirms these choices, and always compile with single precision (I believe that's the default). Try <code> make -k </code> if you get errors relating to drawstuff, test*, or openGL. <code> make install </code> should put <tt>libode.so</tt> in the proper place (usually <tt>/usr/local/lib</tt>), and it should be seen by opensim (<tt>ode.net.dll</tt>)

'''''Note:''' if OpenSim fails to launch with <tt>Exception: System.DllNotFoundException: ode</tt>, after compiling ODE, just copy <tt>libode.so</tt> from its usual place (probably <tt>/usr/local/lib/</tt>) to ./bin/, as per [http://metafuturing.net/index.php/OpenSim_Notebook_1 this suggestion]''

==== Setting up ODE for 64 Bits systems: ====

HOWTO on setting up and Install OpenSim on SLES10 - SP1 64Bit

1. I installed Mono 2.01, added this installation source in Yast2
This distro supports installing packages via YaST. Add the following installation source to YaST:
* http://ftp.novell.com/pub/mono/download-stable/SLE_10 [^]
For assistance with using repositories and installing packages with YaST, visit the Yast help page.

"nant" was installed also via this operation.

2. I installed subversion from http://software.opensuse.org/search [^]

SLES/SLED10 ->
subversion-1.5.2-34.2.x86_64.rpm

3. I downloaded and installed the lastest SVN version of opensim as usual (like a 32 bit system):
http://opensimulator.org/wiki/Build_Instructions [^]

4. I downloaded and installed the Open Dynamics Engine (ODE) to replace the 32 bit version of ODE with a 64 bit version.

I did that with the following linux commands:
(it is expected that you have all required Linux building tools installed):

# cd
# svn co http://opensimulator.org/svn/opensim-libs/trunk/unmanaged/OpenDynamicsEngine [^]
# cd OpenDynamicEngine
# chmod a+x ou/bootstrap
# sh autogen.sh

I installed/updated SLES10 with these rpm's for autogen.sh to run properly. http://software.opensuse.org/search [^]

SLES/SLED10 ->
- autoconf-2.61-168.1.x86_64.rpm
- automake-1.10.1-5.3.x86_64.rpm

# CFLAGS="-m64" ./configure --enable-shared
# make

I installed gtk2-devel via yast2, and all its dependancies, because make keept failing.

# cp ./ode/src/.libs/libode.so /opt/opensim/bin/

note:
in this directory it had made several versions of the "libode.so" because of running the previous commands several times
so i had to copy libode.so.1.0.0 to /opt/opensim/bin/libode.so

# vi ../opensim/bin/OpenSim.ini (change av_capsule_standup_tensor_linux to 1700000)

The 'chmod' command is required to fix permissions that are wrong.
The change in OpenSim.ini is required to avoid that avatars have bend legs and/or their feet are in the ground.

==== Running ====
Recent versions of OpenSim come without an <tt>OpenSim.ini</tt> file. Copy the <tt>OpenSim.ini.example</tt> file to <tt>OpenSim.ini</tt> before making any changes.
<code>
cd bin
mono OpenSim.exe
</code>

Note: if you are running a 32bit Server such as Ubuntu 8.0.4 you need the alternative launcher:

<code>
mono OpenSim.32BitLaunch.exe
</code>

* To invoke ODE, add the option:
-physics=OpenDynamicsEngine
to the <tt>mono OpenSim.exe</tt> line

or add <code> physics = OpenDynamicsEngine </code> to the [Startup] section of <tt>OpenSim.ini</tt>. Same deal for other physics engines, when available.

On mono 1.2.6, some distributions may see
Unhandled Exception: System.NotSupportedException: CodePage 1252 not supported
on startup when using mysql. This can be resolved by installing the package libmono-i18n2.0-cil (see http://bugs.mysql.com/bug.php?id=33938).

== Hardware selection guide ==

An often-asked question is "what kind of hardware do I need to successfully run OpenSim?" Unfortunately, the answer is "it depends". The number of regions hosted on a given machine, number of simultaneous avatars on those regions, number of prims, use of scripts, etc., all affect hardware requirements. So, to help you make a more informed selection, some examples of hardware used are listed in the [[Hardware_Selection_Guide|hardware selection guide]].

[[Category:Users]]
[[Category:Getting Started]]