{"id":2215,"date":"2016-07-03T15:28:27","date_gmt":"2016-07-03T21:28:27","guid":{"rendered":"http:\/\/www.mooreds.com\/wordpress\/?p=2215"},"modified":"2016-08-05T16:53:51","modified_gmt":"2016-08-05T22:53:51","slug":"adding-a-sitemap-to-sharetribe","status":"publish","type":"post","link":"https:\/\/www.mooreds.com\/wordpress\/archives\/2215","title":{"rendered":"Adding a sitemap to sharetribe"},"content":{"rendered":"

\"map-1434486_640\"I have using the excellent Sharetribe<\/a> framework to build a marketplace for food businesses and commercial kitchens for my new startup, The Food Corridor<\/a>.\u00a0 However, it didn’t have support for generating a sitemap.xml<\/code> file for all the listings available.<\/p>\n

How is someone going to find the right kitchen space when they use google, but we don’t have a sitemap so google can keep apprised of all the options?<\/p>\n

This wouldn’t do.\u00a0 So, I added the ability to generate a sitemap for all the listings in the marketplace.<\/p>\n

First off, install the gem–I used sitemap_generator<\/a> as it seemed to do what I needed–allow me to call out certain routes and add them to my sitemap.\u00a0 Then you need to create a configuration file, at config\/sitemap.rb<\/code>.\u00a0 Mine looks like:<\/p>\n

\r\nSitemapGenerator::Sitemap.default_host = \"https:\/\/\"+APP_CONFIG.domain\r\n\r\nSitemapGenerator::Sitemap.create do\r\n  Listing.where(deleted: false, open: true).find_each do |listing|\r\n    add listing_path(listing), :lastmod => listing.updated_at\r\n  end\r\nend\r\n<\/code><\/pre>\n
 <\/p>\n
Then I just ran bundle exec rake sitemap:refresh:no_ping<\/code> and a sitemap.xml.gz<\/code> was generated in my public<\/code> directory.<\/p>\n
If you are running on AWS or someplace else with a persistent filesystem, you can skip to the text starting with “Then, I scheduled”.<\/p>\n
If you are running on a PAAS like Heroku, where you don’t get a persistent filesystem, you’ll want to push this generated file to a persistent place. I chose S3. Since sharetribe already has paperclip as a dependency, I used the instructions here<\/a> and here<\/a>, with a few modifications for sharetribe.  <\/p>\n
My rake task to upload the sitemap file was:<\/p>\n
\r\nrequire 'aws'\r\nnamespace :sitemap do\r\n  desc 'Upload the sitemap files to S3'\r\n  task upload_to_s3: :environment do\r\n    s3 = AWS::S3.new(\r\n      access_key_id: ENV['aws_access_key_id'],\r\n      secret_access_key: ENV['aws_secret_access_key']\r\n    )\r\n    bucket = s3.buckets[ENV['s3_bucket_name']]\r\n      file = File.join(Rails.root, \"public\", \"sitemap.xml.gz\")\r\n      path = \"sitemap\/sitemap.xml.gz\"\r\n\r\n      begin\r\n        object = bucket.objects[path]\r\n        object.write(file: file)\r\n        object.acl=(:public_read)\r\n      rescue Exception => e\r\n        raise e\r\n      end\r\n  end\r\nend\r\n\r\n<\/code>\r\n<\/pre>\n
I then run the sitemap:refresh:no_ping<\/code> and upload_to_s3<\/code> tasks in the same heroku scheduled task: rake sitemap:refresh:no_ping sitemap:upload_to_s3<\/code>. If you don’t do that (and instead do separate dynos) then the upload task won’t have access to the file (because it will have been generated on the first dyno’s filesystem).<\/p>\n
You also need to make sure to add a sitemap controller to redirect from yourdomain.com\/sitemap.xml.gz<\/code> to the S3 bucket (again, as outlined in the articles linked above.<\/p>\n
Then, I scheduled a daily refresh of the sitemap.xml<\/code> file and submitted the file to relevant search engines.<\/p>\n
Things I didn’t do:<\/p>\n