GridInfo

From OpenSimulator

(Difference between revisions)
Jump to: navigation, search
m (aczelo)
 
(14 intermediate revisions by 8 users not shown)
Line 1: Line 1:
monorlivar
+
__NOTOC__ {{Quicklinks}} <br />
The '''GridInfo protocol''' was suggested by [http://mjm.game-host.org/opensim:viewer:contents mana janus] to facilitate autoconfiguration of clients. With the GridInfo protocol a smart client only needs to have the URI of the user server or the standalone server and can then obtain parameters such as the welcome page, the helper URI (for the economy subsystem), the name of the grid and other information automatically.
+
  
Retrieving the GridInfo is just a simple HTTP GET call to /get_grid_info on either the standalone server's URL or on the grid's user server:
+
The '''GridInfo protocol''' was suggested by [http://mjm.game-host.org/opensim:viewer:contents mana janus] to facilitate autoconfiguration of clients. With the GridInfo protocol a smart client only needs to have the URI of the user server or the standalone server and can then obtain parameters such as the welcome page, the helper URI (for the economy subsystem), the name of the grid and other information automatically.
  
<pre>
+
Retrieving the GridInfo is just a simple HTTP GET call to /get_grid_info on either the standalone server's URL or on the grid's user server:
% GET http://127.0.0.1:9000/get_grid_info | xml_pp
+
<pre>% GET http://127.0.0.1:9000/get_grid_info | xml_pp
<gridinfo>
+
&lt;gridinfo&gt;
   <login>http://127.0.0.1:9000/</login>
+
   &lt;login&gt;http://127.0.0.1:9000/&lt;/login&gt;
   <gridname>the lost continent of hippo</gridname>
+
   &lt;gridname&gt;the lost continent of hippo&lt;/gridname&gt;
   <mode>standalone</mode>
+
   &lt;mode&gt;standalone&lt;/mode&gt;
   <register>http://127.0.0.1/register</register>
+
   &lt;register&gt;http://127.0.0.1/register&lt;/register&gt;
   <platform>OpenSim</platform>
+
   &lt;platform&gt;OpenSim&lt;/platform&gt;
   <help>http://127.0.0.1/help</help>
+
   &lt;help&gt;http://127.0.0.1/help&lt;/help&gt;
   <about>http://127.0.0.1/about/</about>
+
   &lt;about&gt;http://127.0.0.1/about/&lt;/about&gt;
   <welcome>http://127.0.0.1/welcome</welcome>
+
   &lt;welcome&gt;http://127.0.0.1/welcome&lt;/welcome&gt;
   <gridnick>hippogrid</gridnick>
+
   &lt;gridnick&gt;hippogrid&lt;/gridnick&gt;
   <password>http://127.0.0.1/password</password>
+
   &lt;password&gt;http://127.0.0.1/password&lt;/password&gt;
   <economy>http://127.0.0.1:9000/</economy>
+
   &lt;economy&gt;http://127.0.0.1:9000/&lt;/economy&gt;
</gridinfo>
+
&lt;/gridinfo&gt;
 
</pre>
 
</pre>
 
+
which was "generated" by the following [GridInfo] section:  
which was "generated" by the following [GridInfo] section:
+
<pre>[GridInfo]
<pre>
+
[GridInfo]
+
 
; login uri
 
; login uri
 
login = http://127.0.0.1:9000/
 
login = http://127.0.0.1:9000/
Line 43: Line 40:
 
gridnick = "hippogrid"
 
gridnick = "hippogrid"
 
</pre>
 
</pre>
</pre>
+
Have a look at OpenSim.ini.example for all GridInfo options --- note, that you can add additional keys there, they are automatically included in the response.
 +
 
 +
NOTE: The configuration location of GridInfo has changed.&nbsp;
  
Have a look at the option table in the [[OpenSim.ini]] section for all GridInfo options --- note, that you can add additional keys there, they are automatically included in the response.
+
* In versions 0.6.9 and below, it is found in OpenSim.ini
 +
* In version 0.7.0, GridInfo is missing.&nbsp; Please update to 0.7.0.1 or newer
 +
* In version 0.7.0.1 and newer, it is located in StandaloneCommon.ini for standalones and located in Robust.ini for grids

Latest revision as of 10:12, 30 June 2021


The GridInfo protocol was suggested by mana janus to facilitate autoconfiguration of clients. With the GridInfo protocol a smart client only needs to have the URI of the user server or the standalone server and can then obtain parameters such as the welcome page, the helper URI (for the economy subsystem), the name of the grid and other information automatically.

Retrieving the GridInfo is just a simple HTTP GET call to /get_grid_info on either the standalone server's URL or on the grid's user server:

% GET http://127.0.0.1:9000/get_grid_info | xml_pp
<gridinfo>
  <login>http://127.0.0.1:9000/</login>
  <gridname>the lost continent of hippo</gridname>
  <mode>standalone</mode>
  <register>http://127.0.0.1/register</register>
  <platform>OpenSim</platform>
  <help>http://127.0.0.1/help</help>
  <about>http://127.0.0.1/about/</about>
  <welcome>http://127.0.0.1/welcome</welcome>
  <gridnick>hippogrid</gridnick>
  <password>http://127.0.0.1/password</password>
  <economy>http://127.0.0.1:9000/</economy>
</gridinfo>

which was "generated" by the following [GridInfo] section:

[GridInfo]
; login uri
login = http://127.0.0.1:9000/
; login page
welcome = http://127.0.0.1/welcome
; helper uri
economy = http://127.0.0.1:9000/
; web page of grid
about = http://127.0.0.1/about/
; account creation
register = http://127.0.0.1/register
; help
help = http://127.0.0.1/help
; password help
password = http://127.0.0.1/password
; long grid name
gridname = "the lost continent of hippo"
; short grid name
gridnick = "hippogrid"

Have a look at OpenSim.ini.example for all GridInfo options --- note, that you can add additional keys there, they are automatically included in the response.

NOTE: The configuration location of GridInfo has changed. 

  • In versions 0.6.9 and below, it is found in OpenSim.ini
  • In version 0.7.0, GridInfo is missing.  Please update to 0.7.0.1 or newer
  • In version 0.7.0.1 and newer, it is located in StandaloneCommon.ini for standalones and located in Robust.ini for grids
Personal tools
General
About This Wiki