Framework guide

Dynamic Open Graph images for Rails

In `app/views` or a helper, set `og:image` with `tag :meta, property: "og:image", content: ogkit_url` built from your API key and title.

Every framework only needs a stable, absolute HTTPS og:image. OGKit gives you one URL, production templates, and query parameters for titles, images, logos, authors, products, events, jobs, and code snippets.

Server-rendered metadata is the SEO boundary

Open Graph images only help distribution when the final HTML response already contains the metadata. Most scrapers do not wait for client-side JavaScript, so React hydration, client routers, and analytics callbacks are too late. Build the OGKit URL in the server route, loader, layout, view helper, or static generation step that owns the document head.

Use one deterministic image URL per canonical page

The strongest pattern is one stable 1200x630 image URL for each canonical URL. Put the same image in Open Graph and Twitter/X metadata, keep the title aligned with the visible H1, and include page-specific context such as author, product name, release version, or docs section. That gives Slack, Discord, LinkedIn, iMessage, and browser-assisted LLM crawlers the same topic signal as the page body.

When to choose hosted templates over custom renderers

Custom Satori, Puppeteer, or screenshot routes make sense when you need arbitrary layout control. Hosted templates make more sense when the business need is repeatable: blog cards, launch pages, changelogs, docs pages, product pages, and comparison pages that should look consistent without a renderer living in every codebase.

Implementation pattern

Generate the OGKit URL before the crawler sees the HTML. That can happen during static generation, in a server route, or in the framework metadata layer. Start with the API reference, deep guides, test the URL in the Playground, then validate the deployed page with the preview debugging tools.

# app/helpers/ogkit_helper.rb
module OgkitHelper
  def ogkit_image_url(title:, subtitle: nil, template: "article")
    uri = URI("https://www.webmorp.art/api/og/#{template}")
    params = { key: ENV.fetch("OGKIT_KEY"), title: title }
    params[:subtitle] = subtitle if subtitle.present?
    uri.query = URI.encode_www_form(params)
    uri.to_s
  end
end

# app/views/layouts/application.html.erb
<meta property="og:image" content="<%= ogkit_image_url(title: @post.title, subtitle: @post.excerpt) %>">
<meta name="twitter:image" content="<%= ogkit_image_url(title: @post.title, subtitle: @post.excerpt) %>">

Deeper Rails notes

Helpers over string concat

Centralize URL building in a helper or presenter so every mailer preview and blog layout stays consistent. Add optional template: "product" for commerce pages.

Credentials

Store OGKIT_KEY in Rails credentials or the host ENV. Never commit it to config/credentials.yml.enc plaintext in git discussions — rotate if leaked.

Worked steps

Add OGKIT_KEY to ENV/credentials.
Ship OgkitHelper.
Call it from the layout with @post fields.
Test with opengraph.xyz after deploy.

Checklist

Build a helper for OGKit URLs.
Keep keys in Rails credentials or ENV.
Escape and encode dynamic values via URI.encode_www_form.
Set both og:image and twitter:image.

Common pitfalls

Rendering unencoded query strings
Putting keys into frontend packs
Forgetting background jobs are unnecessary for simple cards
Using relative asset paths as og:image

When a hosted OG API makes sense

A hosted Open Graph image API is useful when you need consistent cards across many pages but do not want to maintain a custom renderer in every app. It is especially useful for docs, changelogs, launch pages, public customer pages, and content collections where the title and summary change often. For HMAC signing and rescrape workflows, see signed URLs and caching & rescrape.

Frequently asked questions

How do I add dynamic Open Graph images to Rails?

Build an absolute OGKit image URL on the server or during static generation, then place it in og:image and twitter:image metadata for each important page.

Can I use OGKit with Rails without a custom image route?

Yes. OGKit returns a normal 1200x630 PNG URL from template and query parameters, so you do not need to maintain a Satori, Puppeteer, or screenshot pipeline.

Where should I keep the OGKit API key?

Keep the API key in server-side environment variables, framework runtime config, or build-time secrets. Do not bundle it into client-side JavaScript.

I changed the title but Slack still shows the old card — what now?

Rebuild/redeploy so HTML has the new OGKit query, confirm with curl, then rescrape Facebook/LinkedIn. Slack often needs a new image URL (updated fields or v=). See /guides/troubleshooting.