adding advanced fulltext search to NodeBB

View project onGitHub
TODO / open questions: 
1) How to hook into post changes?
2) How to redirect the search submit action to the plugin custom route?
      - I made a fork of NodeBB
         if you use it go to admin / settings / posts and disabel DB search
         then install the plugin as described below
         (pull request made)

What works:
- indexing new posts to local ES server (localhost:9200)
- automatic index creation "nodebb_posts"
- automatic setting of index mapping for autocompletion 
- custom routes are /nodebb-plugin-elasticsearch/search/:term and /elasticsearch/search:term
- on plugin activation in NodeBB admin GUI, ALL existing posts are indexed automatically
   TODO: store last index date, and index only new ... well but plugin 
   might be activated only once, and it might be an option to trigger the process
   again e.g after changing ES server ...
- search with elasticsearch on my NodeBB fork seti123/NodeBB

Installation (on Debian)

1) ElasticSearch server

apt-get install openjdk-7-jre-headless -y
dpkg -i elasticsearch-0.90.6.deb
## install some useful plugins
/usr/share/elasticsearch/bin/plugin -install mobz/elasticsearch-head
/usr/share/elasticsearch/bin/plugin --install jettro/elasticsearch-gui 

open browser and go to http://localhost:9200/_plugin/head

2) NodeBB plugin

   npm install seti123/nodebb-plugin-elasticsearch

3) restart NodeBB (./nodebb dev), activate plugin in admin and make some posts in nodeBB

# to see plugin loading and debug out put ...
./nodebb dev

On the console you should see some dub messages about indexing all posts ...

4) Check autocomplete feature or search

curl -X POST localhost:9200/nodebb_posts/_suggest -d '
  "nodebb_posts" : {
    "text" : "ElasticSearch",
    "completion" : {
      "field" : "content_suggest"

Title suggested for autocomplete:

{"_shards":{"total":5,"successful":5,"failed":0},"nodebb_posts":[{"text":"ElasticSearch","offset":0,"length":13,"options":[{"text":"Another new blog","score":1.0}]}]}

Lets search

1) curl localhost:9200/nodebb_posts/_search?q=new

OR on NodeBB assuming on localhost

1) http://localhost/elasticsearch/*

Result 1):


    "took": 3,
    "timed_out": false,
    "_shards": {
        "total": 5,
        "successful": 5,
        "failed": 0
    "hits": {
        "total": 2,
        "max_score": 0.25,
        "hits": [
                "_index": "nodebb_posts",
                "_type": "nodebb_posts",
                "_id": "26",
                "_score": 0.25,
                "_source": {
                    "pid": 26,
                    "uid": "1",
                    "tid": 23,
                    "content": "<p>this is the first blog entry with ElasticSearch support</p>\n",
                    "timestamp": 1389789466903,
                    "reputation": 0,
                    "editor": "",
                    "edited": 0,
                    "deleted": 0,
                    "title": "A new blog",
                    "content_suggest": [
                        "A new blog",
                        "<p>this is the first blog entry with ElasticSearch support</p>\n"


Result 2) in NodeBB


    "show_no_topics": "hide",
    "show_no_posts": "hide",
    "show_results": "",
    "search_query": "*",
    "posts": [
            "pid": "27",
            "tid": "24",
            "content": "<p>My second entry with ElasticSearch support</p>\n",
            "uid": "1",
            "timestamp": "1389789491362",
            "deleted": "0",
            "fields": [
            "relativeTime": "2014-01-15T12:38:11.362Z",
            "username": "admin",
            "userslug": "admin",
            "user_rep": "1",
            "user_postcount": "37",
            "user_banned": false,
            "picture": "",
            "signature": "",
            "additional_profile_info": "",
            "editorname": null,
            "editorslug": null,
            "categoryName": "Blogs",
            "categoryIcon": "fa-pencil",
            "categorySlug": "4/blogs",
            "title": "2nd entry",
            "topicSlug": "24/2nd-entry"
            "pid": "34",
            "tid": "31",
            "content": "<p>Amazing what you can do with ElasticSearch</p>\n",