# Solidus Dynamic Sitemaps

Solidus Dynamic Sitemaps is a sitemap generator based on the [sitemap_generator][1] gem.
It adheres to the Sitemap 0.9 protocol specification. This is a continuation of
the [original Spree version](https://github.com/spree-contrib/spree_sitemap),
updated to work with the [Solidus](https://solidus.io) eCommerce platform.

### 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 Solidus site (products, taxons, login page, signup page)
- Easily add additional sitemaps for pages you add to your solidus site
- Supports Amazon S3 and other hosting services
- Thin wrapper over battle tested sitemap generator
- Add /sitemap route to display the sitemap

### Configuration Options

Check out the [README][1] for the [sitemap_generator][1].

---

## Installation

1. Add the gem to your Solidus store's `Gemfile`:
   ```ruby
   gem 'solidus_dynamic_sitemaps', github: 'jtapia/solidus_dynamic_sitemaps'
   ```

2. Update your bundle:

   ```
   $ bundle install
   ```

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

   ```
   $ rails g solidus_dynamic_sitemaps:install
   ```

4. Add the sitemap to your `.gitignore`, since it will be regenerated
   server-side.

   ```
   $ echo "public/sitemap*" >> .gitignore
   ```

5. Set up a cron job to regenrate your sitemap via the `rake sitemap:refresh`
   task. If you use the [Whenever gem](https://github.com/javan/whenever), add
   this to your `config/schedule.rb`:

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

6. Ensure 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
   ```

7. Add link to sitemap to a view[Optional]
    `<%= link_to 'Sitemap', '/sitemap' %>`

---

## Acknowledgements

- [The original Spree version of this gem](https://github.com/spree-contrib/spree_sitemap)
- [The creators & contributors of sitemap_generator](http://github.com/kjvarga/sitemap_generator/contributors)
- [Joshua Nussbaum's original implementation of spree-sitemap-generator](https://github.com/joshnuss/spree-sitemap-generator)

---

## Upgrading

If you upgrade from early versions of `solidus_dynamic_sitemaps` you need to change your sitemaps from:
```ruby
SitemapGenerator::Sitemap.add_links do
  # ...
end
```

to this:
```ruby
SitemapGenerator::Sitemap.create do
  # ...
end
```

---

## Contributing

See corresponding [guidelines][2]

---

Copyright (c) 2016 [Stembolt](https://stembolt.com/)

Copyright (c) 2011-2015 [Jeff Dutil][5] and other [contributors][6], released under the [New BSD License][4].

[1]: http://github.com/kjvarga/sitemap_generator
[2]: https://github.com/spree-contrib/spree_i18n/blob/master/CONTRIBUTING.md
[4]: https://github.com/spree-contrib/spree_sitemap/blob/master/LICENSE.md
[5]: https://github.com/jdutil
[6]: https://github.com/solidusio-contrib/solidus_sitemap/graphs/contributors