Spree Sitemap

Spree Sitemap is a sitemap generator based on the sitemap_generator gem. It adheres to the Sitemap 0.9 protocol specification.

Features

• Notifies search engine of new sitemaps (Google, Yahoo, Ask, Bing)
• Supports large huge product catalogs
• Adheres to 0.9 Sitemap protocol specification
• Compresses sitemaps with gzip
• Provides basic sitemap of a Spree site (products, taxons, login page, signup page)
• Easily add additional sitemaps for pages you add to your spree site
• Supports Amazon S3 and other hosting services
• Thin wrapper over battle tested sitemap generator

Configuration Options

Check out the README for the sitemap_generator.

Installation

1. add the gem to your Gemfile:

gem 'spree_sitemap', github: 'jdutil/spree_sitemap', branch: 'master'

2. run bundler:

bundle install

3. run the installer, it will create a config/sitemap.rb file with some sane defaults

rails g spree_sitemap:install

4. add sitemap to your .gitignore

echo "public/sitemap*" >> .gitignore

5. setup a daily cron job to regenrate your sitemap via the rake sitemap:refresh task. If you use the Whenever gem, add this to your config/schedule.rb

every 1.day, at: '5:00 am' do
  rake '-s sitemap:refresh'
end

6. make sure crawlers can find the sitemap, by adding the following line to your public/robots.txt with your correct domain name

echo "Sitemap: http://www.example.com/sitemap.xml.gz" >> public/robots.txt

TODO

• Add spec for sitemap rake task

Thanks

• The creators & contributors of sitemap_generator
• Joshua Nussbaum's original implementation of spree-sitemap-generator

Contributing

In the spirit of free software, everyone is encouraged to help improve this project.

Here are some ways you can contribute:

• by using prerelease versions
• by reporting bugs
• by suggesting new features
• by writing or editing documentation
• by writing specifications
• by writing code (no patch is too small: fix typos, add comments, clean up inconsistent whitespace)
• by refactoring code
• by resolving issues
• by reviewing patches

Donating

Bitcoin donations may be sent to: 18HEAFjeDaa15AihyGvKvR19XEkm5aCJk5

Copyright (c) 2014 Jeff Dutil and contributors, released under the New BSD License.