【Rails】 sitemap_generatorを使ってサイトマップを作成しよう

1
gem 'sitemap_generator'

1
bundle exec rake sitemap:install

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
# Set the host name for URL creation
SitemapGenerator::Sitemap.default_host = "http://www.example.com"

SitemapGenerator::Sitemap.create do
  # Put links creation logic here.
  #
  # The root path '/' and sitemap index file are added automatically for you.
  # Links are added to the Sitemap in the order they are specified.
  #
  # Usage: add(path, options={})
  #        (default options are used if you don't specify)
  #
  # Defaults: :priority => 0.5, :changefreq => 'weekly',
  #           :lastmod => Time.now, :host => default_host
  #
  # Examples:
  #
  # Add '/articles'
  #
  #   add articles_path, :priority => 0.7, :changefreq => 'daily'
  #
  # Add all articles:
  #
  #   Article.find_each do |article|
  #     add article_path(article), :lastmod => article.updated_at
  #   end
end

1
2
# Set the host name for URL creation
SitemapGenerator::Sitemap.default_host = "http://www.example.com"

1
2
3
4
5
6
# Set the host name for URL creation
SitemapGenerator::Sitemap.default_host = "http://www.example.com"

SitemapGenerator::Sitemap.create do
  add '追加するURL', priority: 0.5, changefreq: 'daily', lastmod: '2024-01-01T00:00:00+00:00' 
end

1
2
3
SitemapGenerator::Sitemap.create do
  add '追加するURL', priority: 値
end

1
2
3
SitemapGenerator::Sitemap.create do
  add '追加するURL', changefreq: '値'
end

1
2
3
SitemapGenerator::Sitemap.create do
  add '追加するパス', lastmod: '値'
end

1
2
YYYY-MM-DD
YYYY-MM-DDThh:mm:ssTZD（例： 2024-01-01T00:00:00+00:00）

1
2
3
4
5
6
7
# デフォルトのホスト名を指定
SitemapGenerator::Sitemap.default_host = "http://www.example.com"

SitemapGenerator::Sitemap.create do
  # host属性を使い、デフォルトのホスト名以外を指定
  add '/login', host: 'https://secure.example.com'
end

1
2
3
4
5
6
7
8
9
<?xml version="1.0" encoding="UTF-8"?>
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
  <url>
    <loc>https://secure.example.com/login</loc>
    <lastmod>2024-01-01T00:00:00+09:00</lastmod>
    <changefreq>weekly</changefreq>
    <priority>0.5</changefreq>
  </url>
</urlset>

1
2
3
4
5
SitemapGenerator::Sitemap.default_host = "http://www.example.com"

SitemapGenerator::Sitemap.create do
  add '/articles', changefreq: 'monthly', priority: 0.8
end

1
2
3
4
5
6
7
8
9
<?xml version="1.0" encoding="UTF-8"?>
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
  <url>
    <loc>https://www.example.com/articles</loc>
    <lastmod>2024-01-01T00:00:00+09:00</lastmod>
    <changefreq>monthly</changefreq>
    <priority>0.8</changefreq>
  </url>
</urlset>

1
2
3
SitemapGenerator::Sitemap.create do
  add articles_path, changefreq: 'monthly', priority: 0.8
end

1
2
3
4
5
SitemapGenerator::Sitemap.create do
  Article.find_each do |article|
    add article_path(article), lastmod: article.updated_at, priority: 0.7
  end
end

1
bundle exec rake sitemap:refresh

1
2
3
In '/Users/username/appname/public/':
+ sitemap.xml.gz.     2 links /  353 Bytes
Sitemap stats: 2 links / 1 sitemaps / 0m00s

1
2
3
bundle exec rake sitemap:refresh:no_ping
# もしくは
bundle exec rake sitemap:create

1
gzip -d public/sitemap.xml.gz

1
xmllint --format public/sitemap.xml -o public/formatted_sitemap.xml

1
bundle exec rake sitemap:clean

1
2
3
4
5
6
7
8
9
10
11
12
SitemapGenerator::Sitemap.default_host = "http://www.example.com"
SitemapGenerator::Sitemap.sitemaps_host = "サイトマップを設置するホスト名"
SitemapGenerator::Sitemap.public_path = "ローカルでの生成場所"
SitemapGenerator::Sitemap.sitemaps_path = "生成先のディレクトリ名"
SitemapGenerator::Sitemap.adapter = SitemapGenerator::S3Adapter.new(
                                      fog_provider: 'AWS',
                                      aws_access_key_id: "AWSアクセスキーID",
                                      aws_secret_access_key: "AWSシークレットアクセスキー",
                                      fog_directory: "バケット名",
                                      fog_region: "AWSのリージョン")

# 〜略

1
2
3
4
5
6
7
8
9
10
11
12
SitemapGenerator::Sitemap.default_host = "http://www.example.com"
SitemapGenerator::Sitemap.sitemaps_host = "https://s3-ap-northeast-1.amazonaws.com/#{ENV['S3_BUCKET']}/"
SitemapGenerator::Sitemap.public_path = "tmp/"
SitemapGenerator::Sitemap.sitemaps_path = "sitemaps/"
SitemapGenerator::Sitemap.adapter = SitemapGenerator::S3Adapter.new(
                                      fog_provider: 'AWS',
                                      aws_access_key_id: ENV['AWS_ACCESS_KEY_ID'],
                                      aws_secret_access_key: ENV['AWS_SECRET_ACCESS_KEY'],
                                      fog_directory: ENV['S3_BUCKET'],
                                      fog_region: "ap-northeast-1")

# 〜略

1
2
# サイトマップのURLを追加
Sitemap: https://バケット名.s3.ap-northeast-1.amazonaws.com/sitemaps/sitemap.xml.gz

1
gem 'whenever', require: false

1
bundle exec wheneverize .

1
2
[add] writing `./config/schedule.rb'
[done] wheneverized!

1
2
3
4
5
6
7
8
9
10
# 環境を指定
set :environment, "production"

# job_type をカスタマイズして bundle exec を使用
job_type :rake, "cd :path && bundle exec rake :task --silent :output"

# 例：毎日深夜にサイトマップを生成するジョブを追加
every 1.day, at: '12:00 am' do
  rake "sitemap:refresh"
end

1
bundle exec whenever --update-crontab

1
[write] crontab file updated

1
crontab -l

1
2
3
4
# Begin Whenever generated tasks for: /Users/username/dev/appname/config/schedule.rb at: 2024-01-01 01:01:00 +0900
0 0 * * * /bin/bash -l -c 'cd /Users/username/dev/appname && bundle exec rake sitemap:refresh --silent'

# End Whenever generated tasks for: /Users/username/dev/appname/config/schedule.rb at: 2024-01-01 01:01:00 +0900