Sphinx search Beta for vBulletin 4.0
Please read first:
Install Sphinx
--------------
Configure for vBulletin
-----------------------
We will be creating a forum on vbulletin.org for discussion on the future development of the sphinx search product. I will update this announcement with a link when that is complete.
Thanks, and enjoy,
Adrian
Attached Files
More...
Please read first:
- Please do not install this product unless you have a strong technical background
- We are not responsible for any conflicts or errors that occur with installing and/or operating sphinx
- We recommend testing this product on a test instance of vBulletin first
- This product is in Beta, and is not supported*
- Do not upload your vbulletin-sphinx.php to a web accessible URL. Doing so would give away your database details. If you follow these exact instructions, it will not be in a web accessible URL.
- The purpose of this product is to reduce database load (and reduce page load times) for sites that have large post databases and high activity. Boards that have less 4million posts and 3million pageviews a month will see a significantly reduced benefit from this product, and we see little need to install it on smaller sites that donÂ’t exceed both of those metrics.
- To install this sphinx search package, you must have the following things:
- Must have a Unix Server – package will not work with other server environments
- Have root access to the server
- Have a mySQL developer package (Yum, apt and RPM etc. – downloadable from mysql.com)
- GCC component (c++ compiler on host)
- The product is to be installed on your webserver
- Only install the version of sphinx specified in the instructions (newer and/or older versions may not function correctly)
- Follow the instructions below exactly – you may need to make some adjustments based on “the flavor” of your unix system, and your installation of vBulletin.
- This sphinx product attempts to replicate vBulletin default search functionality 100% to mirror user experience – so any bugs in the default vB4.0 search (or issues with its operation in general) will also occur with sphinx
- If you would like to see an implementation of the product please go to www.bikeforums.net
- If you adjust any of your config.php credentials you will need to restart your webserver/sphinx.
- If you rebuild the threads in the admincp, you must re-run the main.sh
- As of right now, there is no easy way of allowing this on more than one board per server. Should you want to, you would need to modify the sphinx config file, vbulletin config file, directories, cron files, etc. Also this is assuming you are running the Suite. It may work without but will throw an error on the indexing.
- We have tried our best to offer as best guidance we can here in installing the product, and the product works on a number of instances of vbulletin with no known issues, but ultimately (as mentioned) we will not be responsible for any issues in installing it.
Install Sphinx
--------------
- Login as root
- wget http://www.sphinxsearch.com/download...x-0.9.8.tar.gz
- tar xzf sphinx-0.9.8.tar.gz
- cd sphinx-0.9.8
- ./configure --enable-id64 --prefix=/usr/local/sphinx
- make
- Did you get Error 127 during step 6? Install gcc-c++ using the following command and then repeat step 6.
yum install gcc-c++ - make install
- Did you get dependency errors with steps 6 or 8? Install mysql-devel using the following command and then repeat steps 6 and 8.
yum install mysql-devel
Configure for vBulletin
-----------------------
- Import product to vBulletin AdminCPÂ’s Product Manager.
- Upload the contents of the upload folder to the vbulletin root directory.
- Assuming your forum is located in /home/vbulletin/public_html, Also you must define where your sphinx folder is located (different depending on where you ran the above commands). Then use this command:
cp /path/to/sphinx-0.9.8/api/sphinxapi.php /home/vbulletin/public_html/packages/vbsphinxsearch - At the end of your vbulletin config.php file, add the following:
/*
* Sphinx configuration parameters
*/
$config['sphinx']['host'] = '127.0.0.1';
$config['sphinx']['port'] = 3312;
$config['sphinx']['path'] = '/usr/local/sphinx'; /* No trailing slash */ - Upload vbulletin-sphinx.php to /usr/local/sphinx/etc alongside the default sphinx.conf (May be named sphinx.conf.dist) file.
- Change $myforumroot in vbulletin-sphinx.php to the exact forum root (Example: /home/vbulletin/public_html).
- Set vbulletin-sphinx.php file to executable using:
chmod +x /usr/local/sphinx/etc/vbulletin-sphinx.php - Change directory to your sphinx folder using:
cd /usr/local/sphinx - Get the cron zip using:
wget http://carblog.com/vbsphinxsearch/cron.zip - Unzip the cron.zip file using:
unzip cron.zip - Set all crons to executable using command:
chmod +x /usr/local/sphinx/cron/*.sh - Run the main_norotate.sh cron using:
/usr/local/sphinx/cron/main_norotate.sh - Run the delta_norotate.sh cron using:
/usr/local/sphinx/cron/delta_norotate.sh - Start the daemon using:
/usr/local/sphinx/bin/searchd --config /usr/local/sphinx/etc/vbulletin-sphinx.php - To verify your Sphinx is working you can enter: ps ax | grep search[d]
If the above returned something such as: /usr/local/sphinx/bin/searchd --config... the daemon is running. - You should setup crons to run every 10 minutes on /usr/local/sphinx/cron/delta.sh and run /usr/local/sphinx/cron/main.sh once nightly.
- Go to your AdminCP->Options->Search Type. In the drop down, select Sphinx Search, then hit go.
- That is it! Sphinx should now be working correctly on your board.
We will be creating a forum on vbulletin.org for discussion on the future development of the sphinx search product. I will update this announcement with a link when that is complete.
Thanks, and enjoy,
Adrian
Attached Files
More...