Giter Club home page Giter Club logo

elgg-sphinx's Introduction

Sphinx Search for Elgg 1.8

Uses the open source Sphinx search engine to power search on your Elgg site. This is (theoretically) much faster than mysql's fulltext search engine, and also provides some nice features such as stemming. Read more about Sphinx at http://sphinxsearch.com/.

Currently uses Sphinx for user, group, and object searches only. Falls back to default Elgg search functionality for tag and comment searches.

Installation

WARNING: IT IS CRITICAL THAT YOUR ELGG DATA DIRECTORY BE INSTALLED OUTSIDE THE WEB ROOT BEFORE INSTALLING THIS PLUGIN. FAILING TO DO SO WILL GUARANTEE EXPOSURE OF YOUR DATABASE CREDENTIALS TO THE GENERAL PUBLIC.

Note: Your server may require certain permissions to allow you to install + run Sphinx. If you cannot get those permissions, you should not use this plugin.

Note: all commands are given as if on Linux. For Windows, just add ".exe".

  1. Place the plugin folder in your "mod" directory as "sphinx"
  2. Go to /admin/plugins and activate the "Sphinx Search" plugin
  3. Go to /admin/settings/sphinx and generate the configuration file.
  4. Download Sphinx -- http://sphinxsearch.com/downloads/beta/
  5. Install Sphinx -- http://sphinxsearch.com/docs/manual-2.0.9.html#installation
  6. Start Sphinx

That's it! Here's how to start Sphinx:

/path/to/sphinx/bin/searchd --stop
/path/to/sphinx/bin/indexer --config /elgg/data/root/sphinx/sphinx.conf --all
/path/to/sphinx/bin/searchd --config /elgg/data/root/sphinx/sphinx.conf

You should set up a cron to run the above commands every so often in order to keep the indexes fresh

Testing

I have only tested this plugin on my local Windows machine. I would welcome reports of tests in other environments as well!

Resources

elgg-sphinx's People

Contributors

ewinslow avatar gerard-kanters avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.