Installing and Running Hypergrid

From OpenSimulator

Revision as of 10:08, 13 June 2013 by Justincc (Talk | contribs)

Jump to: navigation, search
Languages Languages: 

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

Contents

Installing & Running OpenSimulator in Hypergrid Mode

The setup for hypergrid differs depending on whether you run OpenSimulator as a standalone or as a grid. There also came considerable changes with version 0.7.

Configuration for OpenSimulator 0.7.3 to 0.7.5

There are some minor changes for Hypergrid configuration in OpenSimulator 0.7.3 compared to 0.7.2. Compared to 0.7.2, ProfileURI parameters become HomeURI parameters instead and lose their extensions (e.g. ProfileServerURI = "http://127.0.0.1:9000/profiles" in [HGInventoryService] in StandaloneCommon.ini becomes HomeURI = "http://127.0.0.1:9000"

Standalone

The configuration for hypergrid is activated in section [Architecture] in file OpenSim.ini. Ensure that the line for Include-HGStandalone is the only one that is uncommented in this section: 

[Architecture]
    ;Include-Standalone    = "config-include/Standalone.ini"
    Include-HGStandalone = "config-include/StandaloneHypergrid.ini"
    ;Include-Grid         = "config-include/Grid.ini"
    ;Include-HGGrid       = "config-include/GridHypergrid.ini"
    ;Include-SimianGrid   = "config-include/SimianGrid.ini"

In StandaloneCommon.ini the network addresses in the following sections must be changed to your external network address: 

[HGInventoryService]
    HomeURI = "http://127.0.0.1:9000"
 
[HGAssetService]
    HomeURI = "http://127.0.0.1:9000"
 
[HGInventoryAccessModule]
    HomeURI = "http://127.0.0.1:9000"
    Gatekeeper = "http://127.0.0.1:9000"
 
[GridService]
    Gatekeeper = "http://127.0.0.1:9000"
 
[Messaging]
    Gatekeeper = "http://127.0.0.1:9000"
 
[LoginService]
    ; ... (other settings in this section) ...
    GatekeeperURI = "http://127.0.0.1:9000"
 
    SRV_HomeURI = "http://127.0.0.1:9000"
    SRV_InventoryServerURI = "http://127.0.0.1:9000"
    SRV_AssetServerURI = "http://127.0.0.1:9000"
    SRV_ProfileServerURI = "http://127.0.0.1:9000"
    SRV_FriendsServerURI = "http://127.0.0.1:9000"
    SRV_IMServerURI = "http://127.0.0.1:9000"
 
[GatekeeperService]
    ; ... (other settings in this section) ...
    ExternalName = "http://127.0.0.1:9000"

If you want to use a different port with these addresses, then you must adjust the HTTP listener port in section [Network] in OpenSim.ini, too: 

[Network]
    ; ... (other settings in this section) ...
    http_listener_port = 9000

As a last step, the regions must be configured according to the previous changes. See #Region Setup for both Grid and Standalone.

Grid

To enable hypergrid for a grid, both the Robust server and the region servers (simulators) must be configured appropriately.

Simulator

The region servers (simulators) that connect to the Robust server read their configuration from file OpenSim.ini. To activate hypergrid for them, the line for Include-HGGrid in section [Architecture] must be uncommented: 

[Architecture]
    ;Include-Standalone    = "config-include/Standalone.ini"
    ;Include-HGStandalone = "config-include/StandaloneHypergrid.ini"
    ;Include-Grid         = "config-include/Grid.ini"
    Include-HGGrid       = "config-include/GridHypergrid.ini"
    ;Include-SimianGrid   = "config-include/SimianGrid.ini"

In GridCommon.ini the network addresses in the following sections must be changed to your external network address: 

[GridService]
    ; === HG ONLY === 
    ;; Change this to the address of your Gatekeeper service
    ;; (usually bundled with the rest of the services in one 
    ;; Robust server in port 8002, but not always)
    Gatekeeper="http://mygridserver.com:8002"
 
[Messaging]
    ; === HG ONLY === 
    ;; Change this to the address of your Gatekeeper service
    ;; (usually bundled with the rest of the services in one 
    ;; Robust server in port 8002, but not always)
    Gatekeeper = "http://mygridserver.com:8002"
 
[HGInventoryAccessModule]
    ;
    ; === HG ONLY ===
    ; Change this to your server
    ; accessible from other grids
    ;
    HomeURI = "http://mygridserver.com:8002"
    Gatekeeper = "http://mygridserver.com:8002"
 
[UserAgentService]
    ;
    ; === HG ONLY ===
    ; Change this to your user agent server (HG robust)
    ;
    UserAgentServerURI = "http://mygridserver.com:8002"

Robust Server

The Robust server is started with configuration file Robust.HG.ini instead of Robust.ini. If this file does not yet exist in your installation, create it by making a copy of Robust.HG.ini.example. Make the changes appropriate for your environment (e.g. adjust the database connection string). For hypergrid, the following settings are relevant: 

[LoginService]
    GatekeeperURI = "http://127.0.0.1:8002"
 
    SRV_HomeURI = "http://127.0.0.1:8002"
    SRV_InventoryServerURI = "http://127.0.0.1:8002"
    SRV_AssetServerURI = "http://127.0.0.1:8002"
    SRV_ProfileServerURI = "http://127.0.0.1:8002/user"
    SRV_FriendsServerURI = "http://127.0.0.1:8002"
    SRV_IMServerURI = "http://127.0.0.1:8002"
 
[GatekeeperService]
    ; ... (other settings in this section) ...
    ExternalName = "http://127.0.0.1:8002"
 
[HGInventoryService]
    HomeURI = "http://127.0.0.1:8002"
 
; * The interface that local users get when they are in other grids.
; * This restricts the access that the rest of the world has to
; * the assets of this world.
; *
[HGAssetService]
    HomeURI = "http://127.0.0.1:8002"

If you want to change the port(s) used with these addresses, you will also need to adjust the ports in parameter 'ServiceConnectors' in section [Startup] and probably the port configured in section [Network] as well.

After these adjustments, the Robust server can be started. On Windows/.NET: 

Robust -inifile=Robust.HG.ini

Or, with Mono (e.g. on Linux or OSX): 

mono Robust.exe -inifile=Robust.HG.ini

Region Setup for both Grid and Standalone

Finally, all your regions must use the same external address that is set for GatekeeperService, for example: 

[Region One]
    ; ... (other settings in this section) ...
    ExternalHostName = "example.com"

For the ports which are used by your regions, TCP and UDP requests must be forwarded through any firewall that is securing your network.

The 4096 Regions Limit

Due to a viewer issue, teleports to destinations that are more than 4096 regions away in any direction will not work as expected. Most viewers will do the teleport but the destination region will not be rendered and thus remain invisible to you. What this means in practice is that if you wish to teleport from a region located at cell coordinates (1000, 1000) you cannot go beyond (5095, 5095). To reach destinations that are placed at farer locations, you should either place your own region closer to the destination, or use some intermediate region that is reachable from both your region and the destination region.

Refer to Public Hypergrid Nodes to see some known grids and standalones and where they are located.

Configuration for current OpenSimulator development code (post 0.7.5)

These are draft instructions for configuring Hypergrid for current OpenSimulator development code (post 0.7.5).

The Hypergrid configuration for OpenSimulator 0.7.5 and before is still valid, where the HomeURI and Gatekeeper had to be configured separately in individual modules and services.

However, there is now a more convenient way to do this by configuring these parameters just once in a new [Hypergrid] section of the appropriate configuration files (e.g. bin/config-include/StandaloneCommon.ini for the standalone architecture and bin/config-include/GridCommon.ini and bin/Robust.HG.ini for the grid architecture).

Below follow specific instructions when using the standalone architecture and when using the grid architecture. Finally, there is a section for actions that need to be performed in both architectures.

Standalone

bin/OpenSim.ini

The configuration for hypergrid is activated in section [Architecture] in file OpenSim.ini. Ensure that the line for Include-HGStandalone is the only one that is uncommented in this section: 

[Architecture]
    ;Include-Standalone    = "config-include/Standalone.ini"
    Include-HGStandalone = "config-include/StandaloneHypergrid.ini"
    ;Include-Grid         = "config-include/Grid.ini"
    ;Include-HGGrid       = "config-include/GridHypergrid.ini"
    ;Include-SimianGrid   = "config-include/SimianGrid.ini"

bin/config-include/StandaloneCommon.ini

The StandaloneHypergrid.ini will then go on to include the StandaloneCommon.ini file in the same directory. This is where Hypergrid settings will be included.

There are two steps to this configuration.

Step 1: Set HomeURI and GatekeeperURI in [Hypergrid] section

As both the simulator and grid services are running in the same process in standalone mode, Hypergrid can be configured by putting your externally accessible address in the [Hypergrid] section.

For example, in 

[Hypergrid]
  ; Uncomment the variables in this section only if you are in
  ; Hypergrid configuration. Otherwise, ignore.
 
    ;# {HomeURI} {Hypergrid} {The Home URL of this world} {}
  ;; If this is a standalone world, this is the address of this instance.
  ;; If this is a grided simulator, this is the address of the external robust server that
  ;; runs the UserAgentsService.
  ;; For example http://myworld.com:9000 or http://myworld.com:8002
  ;; This is a default that can be overwritten in some sections.
  HomeURI = "http://127.0.0.1:9000"
 
    ;# {GatekeeperURI} {Hypergrid} {The URL of the gatekeeper of this world} {}
  ;; If this is a standalone world, this is the address of this instance.
  ;; If this is a grided simulator, this is the address of the external robust server
  ;; that runs the Gatekeeper service.
  ;; For example http://myworld.com:9000 or http://myworld.com:8002
  ;; This is a default that can be overwritten in some sections.
  GatekeeperURI = "http://127.0.0.1:9000"

you need to replace "127.0.0.1" with your external IP or fully qualified domain name (FQDN). For instance, if your FQDN was example.com, your entries would be 

[Hypergrid]
  HomeURI = "http://example.com:9000"
  GatekeeperURI = "http://example.com:9000"

Step 2: Set SRV_* addresses in [LoginService]

In addition to the [Hypergrid] entries, the same domain names or IP addresses need to be set in the [LoginService] section of StandaloneCommon.ini.

For example, in 

[LoginService]
    SRV_HomeURI = "http://127.0.0.1:9000"    
    SRV_InventoryServerURI = "http://127.0.0.1:9000"
    SRV_AssetServerURI = "http://127.0.0.1:9000"
    SRV_ProfileServerURI = "http://127.0.0.1:9000"
    SRV_FriendsServerURI = "http://127.0.0.1:9000"
    SRV_IMServerURI = "http://127.0.0.1:9000"

all the SRV_* entries need to be replaced with your externally accessible IP or fully qualified domain name (FQDN). So again, if your domain was example.com, these entries become 

[LoginService]
    SRV_HomeURI = "http://example.com:9000"    
    SRV_InventoryServerURI = "http://example.com:9000"
    SRV_AssetServerURI = "http://example.com:9000"
    SRV_ProfileServerURI = "http://example.com:9000"
    SRV_FriendsServerURI = "http://example.com:9000"
    SRV_IMServerURI = "http://example.com:9000"

Step 3: Change http_listener_port in bin/OpenSim.ini if necessary

Port 9000 is the default port for a standalone. If you wanted to use a different port then you will have to change both the ports in this section and the HTTP port used by OpenSimulator in the [Network] section of OpenSim.ini. 

[Network]
    http_listener_port = 9000

bin/Regions/*.ini

As a last step, the regions must be configured so that they supply external addresses that are the same as the Hypergrid addresses (e.g. example.com). See #Region Setup for both Grid and Standalone.

Grid

Note: These instructions are still under construction. They need to be changed to incorporate the [Hypergrid] setting shortcut detailed in the standalone section To enable hypergrid for a grid, both the Robust server and the region servers (simulators) must be configured appropriately.

Simulator

The region servers (simulators) that connect to the Robust server read their configuration from file OpenSim.ini. To activate hypergrid for them, the line for Include-HGGrid in section [Architecture] must be uncommented: 

[Architecture]
    ;Include-Standalone    = "config-include/Standalone.ini"
    ;Include-HGStandalone = "config-include/StandaloneHypergrid.ini"
    ;Include-Grid         = "config-include/Grid.ini"
    Include-HGGrid       = "config-include/GridHypergrid.ini"
    ;Include-SimianGrid   = "config-include/SimianGrid.ini"

In GridCommon.ini the network addresses in the following sections must be changed to your external network address: 

[GridService]
    ; === HG ONLY === 
    ;; Change this to the address of your Gatekeeper service
    ;; (usually bundled with the rest of the services in one 
    ;; Robust server in port 8002, but not always)
    Gatekeeper="http://mygridserver.com:8002"
 
[Messaging]
    ; === HG ONLY === 
    ;; Change this to the address of your Gatekeeper service
    ;; (usually bundled with the rest of the services in one 
    ;; Robust server in port 8002, but not always)
    Gatekeeper = "http://mygridserver.com:8002"
 
[HGInventoryAccessModule]
    ;
    ; === HG ONLY ===
    ; Change this to your server
    ; accessible from other grids
    ;
    HomeURI = "http://mygridserver.com:8002"
    Gatekeeper = "http://mygridserver.com:8002"
 
[UserAgentService]
    ;
    ; === HG ONLY ===
    ; Change this to your user agent server (HG robust)
    ;
    UserAgentServerURI = "http://mygridserver.com:8002"

Robust Server

The Robust server is started with configuration file Robust.HG.ini instead of Robust.ini. If this file does not yet exist in your installation, create it by making a copy of Robust.HG.ini.example. Make the changes appropriate for your environment (e.g. adjust the database connection string). For hypergrid, the following settings are relevant: 

[LoginService]
    GatekeeperURI = "http://127.0.0.1:8002"
 
    SRV_HomeURI = "http://127.0.0.1:8002"
    SRV_InventoryServerURI = "http://127.0.0.1:8002"
    SRV_AssetServerURI = "http://127.0.0.1:8002"
    SRV_ProfileServerURI = "http://127.0.0.1:8002/user"
    SRV_FriendsServerURI = "http://127.0.0.1:8002"
    SRV_IMServerURI = "http://127.0.0.1:8002"
 
[GatekeeperService]
    ; ... (other settings in this section) ...
    ExternalName = "http://127.0.0.1:8002"
 
[HGInventoryService]
    HomeURI = "http://127.0.0.1:8002"
 
; * The interface that local users get when they are in other grids.
; * This restricts the access that the rest of the world has to
; * the assets of this world.
; *
[HGAssetService]
    HomeURI = "http://127.0.0.1:8002"

If you want to change the port(s) used with these addresses, you will also need to adjust the ports in parameter 'ServiceConnectors' in section [Startup] and probably the port configured in section [Network] as well.

After these adjustments, the Robust server can be started. On Windows/.NET: 

Robust -inifile=Robust.HG.ini

Or, with Mono (e.g. on Linux or OSX): 

mono Robust.exe -inifile=Robust.HG.ini

Grid and Standalone

Finally, all your regions must use the same external address that is set for GatekeeperService, for example: 

[Region One]
    ; ... (other settings in this section) ...
    ExternalHostName = "example.com"

For the ports which are used by your regions, TCP and UDP requests must be forwarded through any firewall that is securing your network.


Previous Instructions

Installing and Running Hypergrid On OpenSimulator 0.7.2 to 0.7

Installing and Running Hypergrid On OpenSimulator 0.6.9

Additional References

Implemented osFunctions: OSSL Implemented

Enabling osFunctions: OSSL Enabling Functions

HyperGrid Security: Hypergrid Security

Banning Foreign Users in Hypergrid: Banning Foreign Users in Hypergrid

Public HyperGrid Nodes Listing: Public Hypergrid Nodes

Hypergrid Inventory Access: Hypergrid Inventory Access (proposal)

CATEGORY: Hypergrid

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