OpenSimSearch

OpenSimSearch makes it possible to have working Search in OpenSimulator. In the future the "New" search that works with HTML pages.

How to setup OSS

 * Make sure you have a Apache/PHP/MySQL configuration ready else Search won't work!!

You can grab the latest version of OpenSimSearch through git. Use the command below to checkout the code.

Note: For Windows users or those who have not used Git before, the page "Setting Up Git on Windows in Four Easy Steps" may be helpful. Use the information in steps 1 and 2. After you've installed TortoiseGit, create a directory in the location of your choosing and then right click - choose "Git Checkout..." - and enter the URL provided above to download the entire package.

[NOTE: The last sentence in the above paragraph needs to be verified by someone using TortoiseGit]

The following parts are for the Grid owner only

 * In the trunk/bin folder you can find the latest binary release which you can include in your OpenSim. Just grab the DLL file and place it in the bin folder of OpenSimulator.


 * Copy all files in the trunk/webroot to your webserver


 * Create a new database called ossearch


 * Import the SQL file ossearch.sql into your database


 * Make sure you change the databaseinfo.php file to reflect your settings.

The following parts are for the Region owners

 * In the trunk/bin folder you can find the latest binary release which you can include in your OpenSim. Just grab the DLL file and place it in the bin folder of OpenSimulator.


 * Search needs the DataSnapShot module to be activated, here's how to get it activated:


 * Add the following 2 lines to your OpenSim.ini file to get Search activated

[Grid owners]

 * Startup your region server and check your MySQL database table hostregister if the regionserver registered itself. If it registers, that means the DataSnapShot Module is working and you can use Search.

In the trunk/webroot folder there's a file called parser.php. This file is the parser of the info from the DataSnapShot Module. This file needs to be run with cron or some other way. If this file isn't run, the search tables won't be filled and you won't see anything.

To set up a cron job, take a look at this page:


 * http://www.linuxhelp.net/guides/cron/

[Region owners]

 * Startup your region server and have the Grid owner check if your region shows up in the MySQL database table hostregister. When it does, your region now has Search enabled from the Grid

Notes for the Grid Owners

 * If you're a Grid owner, make sure that regionserver can access your Search URL else the Search on those regions will fail.


 * Whenever a sim fails, sometimes the user that has set the cron job up will fire off emails to the root user. These emails can be annoying but only give warnings about it working.