Gloebit Developer Logo

Blog

Sandbox

Main Site

OpenSim Gloebit Money Module Beta - Configuration Instructions

Enabling Gloebit on your OpenSim grid is quick and simple. There are 3 easy steps.

  1. Request account permission to create apps
  2. Create a Gloebit app
  3. Install and configure the Gloebit Money Module

The details for each of these is below. Just follow the step by step instructions.

We have two environments, a Sandbox testing environment and Production. All of the instructions below are for our Production environment, but if you want to test with fake payments and gloebits, you can replace www with sandbox in all the links below.

Request account permission to create apps

If you haven't already, create a Gloebit account. Remember that our Sanbox and Production environments use completely separate accounts, so if you've been testing on Sandbox, you'll still need to create a Production account and go through all the steps below from that account to create a Production app.

From your Gloebit account, fill in and submit our form for requesting app creation permission. We just need some basic contact info.

You'll need to wait for us to review your request before you can move to creating your app. We'll email you once we have.

Create a Gloebit app

Once your account has been granted permission to create apps, you'll gain access to your merchant tools page where you can create and edit your apps. Go there and either click Configure next to an existing app (we may have created one for you labeled "Unknown") or the Add an Application button, which will take you to an app settings page. Follow the instructions below to set up your app.

Now you have an app and you're ready to install and configure the GMM.

Configuration

If you are running the Diva distribution of OpenSim, please follow our Diva specific configuration instructions instead of the instructions below.

  1. Install:
    • Download Gloebit.ini and the Gloebit dll for your version of OpenSim
    • Place Gloebit.dll in your opensim/bin/ directory.
    • Place Gloebit.ini in your ConfigDirectory. By default, this is also opensim/bin/. If you are unsure, you can locate the ConfigDirectory value in the [Startup] section of opensim.ini.
  2. Enable: Make required edits to Gloebit.ini and opensim.ini.
    • In Gloebit.ini, set GLBEnvironment = production (or set it to sandbox for a testing app created in our sandbox environment).
    • In Gleobit.ini, set GLBKey and GLBSecret to the "OAuth Key" and "OAuth Secret" from the application you created above.
    • To enable Gloebit across the entire process (for all regions running under this single OpenSim process):
      • In Gloebit.ini, set Enabled = true
      • In opensim.ini, set economymodule = Gloebit (you may need to add this line to the end of your [Startup] section.
    • To enable Gloebit only for specific regions running under this single OpenSim process:
      • In Gloebit.ini, set Enabled = false
      • In Gloebit.ini, set GLBEnabledOnlyInRegion to a whitespace separated list of the region UUIDs for which you would like the GMM enabled.
  3. Improved Robust Experience: Configure all sims to use the same database
    • If you are running multiple sim processes/servers with the GMM enabled, then we recommend you create a single Gloebit database on a server which all sim processes can access, such as on your robust server. If each sim has it's own database, then your users will have to authorize Gloebit from each sim rather than once and will receive session messaging upon entering each sim rather than once per session.
    • Use GLBSpecificConnectionString and GLBSpecificStorageProvider to define a different database for the Gloebit Tables. If not set, the GMM will use the default ConnectionString set by the DatabaseService section of your configuration.
    • You may need to configure your database to allow connections from remote servers and your firewall to allow connections on port 3306 for your sim servers. You can find instructions for this online, but this is advanced, so you should not attempt this unless you know how to secure your firewall.
  4. Optional Gloebit Configuration Options: Make additional edits to Gloebit.ini for improved, user-friendly behavior (None of these are required).
    • If you entered an "OAuth Key Alias" for your application, you can set GLBKeyAlias to this value.
    • Set GLBOwnerName and GLBOwnerEmail to the name and contact details of a manager of this OpenSim process. These are displayed with certain error messages if there is a configuration issue and user is asked to report this problem to this manager.
    • Use GLBSpecificConnectionString and GLBSpecificStorageProvider to define a different database for the Gloebit Tables. If not set, the GMM will use the default ConnectionString set by the DatabaseService section of your configuration.
  5. Optional OpenSim Configuration Options:
    • Set the currency symbol to G$
      • Be aware that this is a grid wide setting, so you may not want to do this if other currency systems are on use in your grid.
      • Set Currency = "G$" in the [LoginService] section of StandaloneCommon.ini, Robust.ini, or Robust.HG.ini.
    • Make land sales work
      • For standalone grids, Gloebit can handle this direclty from our module if the economy helper-uri is configured. See "Configure the economy helper-uri" below.
      • For robust grids, a script is required on the robust server and the economy helper-uri must also be configured.
        • see "Configure the economy helper-uri" below for how to configure this uri.
        • Your robust server needs a landtool.php script to handle pre-flight checks from the viewer before it will deliver the land purchase event to our module. We recommend this repository from justincc for both the landtool.php script and instructions on how to install it.
    • Make the "Buy Currency" button work
      • If configured, on clicking "Buy Currency", or upon attempting to purchase an object with insufficient funds, this will present an unauthorized user with an authorization message, and will present an authorized user with a cost estimate, and upon clicking purchase, a message with a link to purchase gloebits. We can not yet sell gloebits direclty from the viewer.
      • For standalone grids, Gloebit can handle this directly from our module if the economy helper-uri is configured. See "Configure the economy helper-uri" below.
      • For robust grids, a currency.php script is required in addition to properly configuring the economy helper-uri. We have not yet found a drop-in currency.php file, nor have we had a chance to write one. If someone can provide this resource, please let us know.
    • Configure the economy helper-uri
      • This is required for land sales and for the Buy Currency button to work. See the above sections for additonal details on how to make these function.
      • When changing the economy helper-uri, testing can be challenging. I have discovered the following with Firestorm. If the grid I am testing is the one currently selected to log into, then it will not refresh the economy helper-uri, so I first need to select a different grid from the main screen. Then, I need to open preferences->advanced, select my grid, click refresh, and then click apply. Then I can set the grid to log into back to the my grid, log in, and test it.
      • The economy setting is in the [GridInfoService] secion of your StandaloneCommon.ini, Robust.ini or Robust.HG.ini depending upon your OpenSim configuration.
      • For standalone grids, this must be configured to point at a region with Gloebit enabled, effectively http://<IP or Domain of Grid>:<Port of Region with Gloebit enabled>.
        • You can find the port for each region in your Regions.ini file. Your first region is usually on port 9000 by default
        • If your [CONST] section is configured in OpenSim.ini, then you can simply uncomment this to economy = ${Const|BaseURL}:9000/ and update the port if necessary. Otherwise, you can hard code this like economy = https://www.mygrid.com:9000/.
      • For robust grids, this must be configured to point at the folder where you have placed landtool.php and if you have it, currency.php.
        • This folder and these scripts must be accessible to anyone who has logged into your grid
        • If your [CONST] section is configured in OpenSim.ini, then you can simply uncomment this to economy = ${Const|BaseURL}/economy and replace "economy" with the path to this folder. Otherwise, you can hard code this like economy = https://www.mygrid.com/economy.