Wifi

From OpenSimulator

(Difference between revisions)
Jump to: navigation, search
(Tried to be more comprehensive aboutt config parameterrs.)
Line 7: Line 7:
 
== Introduction ==
 
== Introduction ==
  
Initial information is available from http://www.metaverseink.com/blog/?p=37... (permission to summarise being sought)
+
Initial information is available from http://www.metaverseink.com/blog/?p=37 and is taken here pretty much verbatim for now...
 +
 
 +
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. It's 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 user inventory management
 +
* Welcome page which can be used as viewer -loginpage
 +
 
 +
Wifi has a few interesting properties that make it a good fit for small-to-medium OpenSimulator-based virtual worlds. First of all, it doesn’t require the installation of Apache or other Web servers; it’s all done within the OpenSimulator code base.
  
 
== Diva Distribution ==
 
== Diva Distribution ==
Line 13: Line 25:
 
Wifi is included and enabled by default in the Diva Distribution:
 
Wifi is included and enabled by default in the Diva Distribution:
  
* Description: http://www.metaverseink.com/blog/
+
* 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
 
* Downloads and binary distribution: http://github.com/diva/d2/downloads
 
* Source Code: http://github.com/diva/diva-distribution/
 
* Source Code: http://github.com/diva/diva-distribution/
Line 44: Line 57:
 
Obtain the required modules from the Diva Distribution and place them in the equivalent locations in your OpenSim directory:
 
Obtain the required modules from the Diva Distribution and place them in the equivalent locations in your OpenSim directory:
  
* bin/Diva.Modules.dll (needed or not?)
+
* bin/Diva.Modules.dll
 
* bin/Diva.Wifi.dll
 
* bin/Diva.Wifi.dll
 
* bin/Diva.Wifi.ScriptEngine.dll
 
* bin/Diva.Wifi.ScriptEngine.dll
Line 51: Line 64:
 
* Additional licence or readme text needed?
 
* Additional licence or readme text needed?
  
'''Additions to Robust.ini or Robust.HG.ini'''
+
== Setting Configuration Parameters ==
 +
The complete example file is here:
 +
http://github.com/diva/diva-distribution/blob/master/addon-modules/Wifi/Wifi.ini.example
  
TBD
+
'''Additions to Robust.ini or Robust.HG.ini for Grids or to OpenSim.ini for Standalones'''
  
'''Additions to OpenSim.ini'''
+
  ServiceConnectors = "Diva.Wifi.dll:WifiServerConnector"
  
TBD
+
'''Additions to OpenSim.ini'''
 
+
 
+
== Setting Configuration Parameters ==
+
  
 
   [WifiService]
 
   [WifiService]
Line 74: Line 86:
 
     ;; Do you want to be able to control grid registrations?
 
     ;; Do you want to be able to control grid registrations?
 
     AccountConfirmationRequired = false
 
     AccountConfirmationRequired = false
 +
   
 +
    FemaleAvatarAccount = "Female Avatar"
 +
    MaleAvatarAccount = "Male Avatar"
 +
    NeutralAvatarAccount = "Neutral Avatar"
 
      
 
      
 
     ;; Variables for your mail server
 
     ;; Variables for your mail server
Line 79: Line 95:
 
     SmtpHost = "mail.example.com"
 
     SmtpHost = "mail.example.com"
 
     SmtpPort = "587"
 
     SmtpPort = "587"
     SmtpUsername = "you@example.com"
+
     SmtpUsername = "your_account_in_this_mail_server"
     SmtpPassword = ""
+
     SmtpPassword = "your_password_in_this_mail_server"
  
 
== Wifi URLs When Operational ==
 
== Wifi URLs When Operational ==

Revision as of 15:15, 4 August 2010

Wifi - A Simple Account Management Front-end

"Wifi" stands for "Web Interface For... I" :-)

This is an add-on module that IS NOT IN THE CORE of OpenSim. It is provided by Diva Canto and can be added to OpenSim 0.7 onwards. Please do not ask the core OpenSim team for support.

Contents

Introduction

Initial information is available from http://www.metaverseink.com/blog/?p=37 and is taken here pretty much verbatim for now...

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. It's 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 user inventory management
  • Welcome page which can be used as viewer -loginpage

Wifi has a few interesting properties that make it a good fit for small-to-medium OpenSimulator-based virtual worlds. First of all, it doesn’t require the installation of Apache or other Web servers; it’s all done within the OpenSimulator code base.

Diva Distribution

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

Adding Wifi to your OpenSim Setup

TBA - notes here are guesswork at present. Hoping to clarify what is needed and where its available.

Additions to Standard OpenSim Distribution (from 0.7 onwards)

Source Code Approach

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

Extract the following into your standard OpenSim distribution:

  • addon-modules/Wifi/*
  • addon-modules/1WifiScriptEngine/*
  • add-on-modules/Modules/*
  • WifiPages/*

Use addon-modules/Wifi/Wifi.ini.example as a basis for what to add to the relevant OpenSim.ini and either Robust.ini or Robust.HG.ini depending on your architecture.

More I am sure...

Binary Approach

Partial trial to see what is needed. Not working yet.

Obtain the required modules from the Diva Distribution and place them in the equivalent locations in your OpenSim directory:

  • bin/Diva.Modules.dll
  • bin/Diva.Wifi.dll
  • bin/Diva.Wifi.ScriptEngine.dll
  • WifiPages/*
  • doc/WIFI.txt
  • Additional licence or readme text needed?

Setting Configuration Parameters

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 or to OpenSim.ini for Standalones

 ServiceConnectors = "Diva.Wifi.dll:WifiServerConnector"

Additions to OpenSim.ini

 [WifiService]
   GridName = "grid name"
   LoginURL = "<hostname>:9000|http://<hotsname>:9000 "
   WebAddress = "<hostname>:9000|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
   
   FemaleAvatarAccount = "Female Avatar"
   MaleAvatarAccount = "Male Avatar"
   NeutralAvatarAccount = "Neutral Avatar"
   
   ;; 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"

Wifi URLs When Operational

Examples

  • Diva Tagus Test World (temporary August 2010): [1]
Personal tools
General
About This Wiki