{"id":21442105,"url":"https://github.com/gaffneyc/sunspot-queue","last_synced_at":"2025-10-24T23:31:36.930Z","repository":{"id":3447271,"uuid":"4500395","full_name":"gaffneyc/sunspot-queue","owner":"gaffneyc","description":"Background search indexing using existing worker systems","archived":false,"fork":false,"pushed_at":"2018-01-12T15:01:07.000Z","size":252,"stargazers_count":35,"open_issues_count":10,"forks_count":37,"subscribers_count":6,"default_branch":"master","last_synced_at":"2024-04-25T23:20:18.127Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/gaffneyc.png","metadata":{"files":{"readme":"README.md","changelog":"History.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2012-05-30T21:00:49.000Z","updated_at":"2023-07-22T17:28:04.000Z","dependencies_parsed_at":"2022-09-07T07:31:17.540Z","dependency_job_id":null,"html_url":"https://github.com/gaffneyc/sunspot-queue","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gaffneyc%2Fsunspot-queue","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gaffneyc%2Fsunspot-queue/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gaffneyc%2Fsunspot-queue/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gaffneyc%2Fsunspot-queue/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gaffneyc","download_url":"https://codeload.github.com/gaffneyc/sunspot-queue/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":238044095,"owners_count":19407128,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-23T01:52:35.506Z","updated_at":"2025-10-24T23:31:36.607Z","avatar_url":"https://github.com/gaffneyc.png","language":"Ruby","readme":"# sunspot-queue [![Build Status](https://secure.travis-ci.org/gaffneyc/sunspot-queue.png?branch=master)](http://travis-ci.org/gaffneyc/sunspot-queue)\n\nBackground search indexing using existing worker systems.\n\n## Install\n\n```console\n$ gem install sunspot-queue\n```\n\n## Usage with Rails and Resque\n\nIn your Gemfile\n\n```ruby\ngem \"sunspot-queue\"\ngem \"resque\"\n```\n\nIn config/initializers/sunspot.rb\n\n```ruby\nrequire \"sunspot/queue/resque\"\nbackend = Sunspot::Queue::Resque::Backend.new\nSunspot.session = Sunspot::Queue::SessionProxy.new(Sunspot.session, backend)\n```\n\nStart Resque\n\n```console\n$ QUEUE=sunspot rake resque:work\n```\n\n## Usage with Rails and Sidekiq\n\nIn your Gemfile\n\n```ruby\ngem \"sunspot-queue\"\ngem \"sidekiq\"\n```\n\nIn config/initializers/sunspot.rb\n\n```ruby\nrequire \"sunspot/queue/sidekiq\"\nbackend = Sunspot::Queue::Sidekiq::Backend.new\nSunspot.session = Sunspot::Queue::SessionProxy.new(Sunspot.session, backend)\n```\n\nStart Sidekiq\n\n```console\n$ sidekiq -q sunspot\n```\n\n## Usage with Rails and Delayed::Job \n\nIn your Gemfile\n\n```ruby\ngem \"sunspot-queue\"\ngem \"delayed_job\"\ngem \"delayed_job_active_record\"     # or choose another backend\n```\n\nIn config/initializers/sunspot.rb\n\n```ruby\nrequire \"sunspot/queue/delayed_job\"\nbackend = Sunspot::Queue::DelayedJob::Backend.new\nSunspot.session = Sunspot::Queue::SessionProxy.new(Sunspot.session, backend)\n```\n\nStart Delayed::Job\n\n```console\n$ rake jobs:work \n```\n\n## Configuring Sunspot Queue\n\nIn config/initializers/sunspot.rb\n\n```ruby\nSunspot::Queue.configure do |config|\n  # Override default job classes\n  config.index_job   = CustomIndexJob\n  config.removal_job = CustomRemovalJob\nend\n```\n\n## Configuring Auto Commit\n\nThe sunspot-queue jobs update the Solr index but those changes don't appear in\nsearch results until Solr commits those changes. Solr supports automatically\ncommiting changes based on either the number of changes and / or time between\ncommits.\n\nAdd (or uncomment) the following in solrconfig.xml\n\n```xml\n\u003cautoCommit\u003e\n  \u003cmaxDocs\u003e10000\u003c/maxDocs\u003e\n  \u003cmaxTime\u003e30000\u003c/maxTime\u003e\n\u003c/autoCommit\u003e\n```\n\nSee [Solr's documentation](http://wiki.apache.org/solr/SolrConfigXml#Update_Handler_Section) for more information.\n\n## Note on Patches/Pull Requests\n\n* Fork the project.\n* Add tests to show the problem or test your feature\n* Make your feature addition or bug fix.\n* Send me a pull request. Bonus points for topic branches.\n\nPlease don't make changes to the Rakefile, version, or history.\n\n## Development\n\n```console\n$ gem install bundler\n$ bundle\n$ guard\n```\n\n## Copyright\n\nSee LICENSE for details.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgaffneyc%2Fsunspot-queue","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgaffneyc%2Fsunspot-queue","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgaffneyc%2Fsunspot-queue/lists"}