README.rdoc in xapian_db-1.3.3.1 vs README.rdoc in xapian_db-1.3.4

- old
+ new

@@ -82,21 +82,21 @@ - adapter: :active_record|:datamapper, default: :active_record - language: any iso language code, default: :none (activates spelling corrections, stemmer and stop words if an iso language code ist set) - term_min_length: <n>, default: 1 (do not index terms shorter than n) - term_splitter_count: <n>, default: 0 (see chapter Term Splitting) - - enable_query_flags: <list of flags, separated by colons> - - disable_query_flags: <list of flags, separated by colons> + - enabled_query_flags: <list of flags, separated by colons> + - disabled_query_flags: <list of flags, separated by colons> The following query flags are enabled by default: - FLAG_WILDCARD - FLAG_BOOLEAN - FLAG_BOOLEAN_ANY_CASE - FLAG_SPELLING_CORRECTION - See the xapian docs for all available query flags + See the xapian docs for all available query flags; if you use the enabled_query_flags option, you must list all query flags that you want to enable since enabled_query_flags overwrites the defaults If you do not configure settings for an environment in this file, xapian_db applies the defaults. === Configure an index blueprint @@ -396,11 +396,11 @@ == Production setup Since Xapian allows only one database instance to write to the index, the default setup of XapianDb will not work with multiple app instances trying to write to the same database (you will get lock errors). -Therefore, XapianDb provides two solutions based on queueing systems to overcome this. The first solution uses beanstalk and the second one uses resque. +Therefore, XapianDb provides three solutions based on queueing systems to overcome this. The first solution uses beanstalk, the second one uses resque and the third uses sidekiq. == Installation with beanstalk === 1. Install beanstalkd @@ -485,5 +485,29 @@ Be sure to specify the correct queue name when starting the worker. <b>If you don't provide a queue name, it WON'T take 'xapian_db' by default! Do not start multiple instances of this worker!</b> + +== Installation with Sidekiq + +=== 1. Install and start redis + +Install and start redis as described on the {resque github page}[https://github.com/defunkt/resque]. + +=== 2. Add the sidekiq gem to your config + + gem 'sidekiq' + bundle install + +=== 3. Configure XapianDb to use sidekiq in production + + production: + database: db/xapian_db/production + writer: sidekiq + sidekiq_queue: my_queue + +If you don't specify a queue name XapianDb will use 'xapian_db' by default. + +=== 4. Start sidekiq + + RAILS_ENV=production bundle exec sidekiq