Ruby on Rails

Rails wraps every page in app/views/layouts/application.html.erb, so the snippet goes into that layout's <head>. Read the site ID from a custom config.x setting fed by an environment variable, so the template stays free of hard-coded IDs and each environment can use its own site.

Get your tracking snippet

In your Rybbit dashboard, open Site Settings → Tracking Script and copy your snippet. It looks like this:

<script src="https://app.rybbit.io/api/script.js?siteId=YOUR_SITE_ID" defer></script>

YOUR_SITE_ID is the numeric ID of your site. If you self-host Rybbit, app.rybbit.io is the domain of your own instance.

Add the snippet to Ruby on Rails

Configure the site ID

Add the Rybbit values to your environment (.env if you use dotenv-rails, otherwise your host's environment settings):

RYBBIT_INSTANCE_URL=https://app.rybbit.io
RYBBIT_SITE_ID=YOUR_SITE_ID

Then expose them through the config.x namespace in config/application.rb:

module MyApp
  class Application < Rails::Application
    # ... existing configuration

    config.x.rybbit.instance_url = ENV.fetch("RYBBIT_INSTANCE_URL", "https://app.rybbit.io")
    config.x.rybbit.site_id = ENV["RYBBIT_SITE_ID"]
  end
end

Add the tag to your layout

Open app/views/layouts/application.html.erb and add the tag inside <head>, after the stylesheet and JavaScript tags:

<head>
  <title><%= content_for(:title) || "MyApp" %></title>
  <meta name="viewport" content="width=device-width,initial-scale=1">
  <%= csrf_meta_tags %>
  <%= csp_meta_tag %>
  <%= stylesheet_link_tag "application", "data-turbo-track": "reload" %>
  <%= javascript_importmap_tags %>

  <% if Rails.configuration.x.rybbit.site_id.present? %>
    <script src="<%= Rails.configuration.x.rybbit.instance_url %>/api/script.js?siteId=<%= Rails.configuration.x.rybbit.site_id %>" defer></script>
  <% end %>
</head>

The if guard skips the tag wherever RYBBIT_SITE_ID is unset, so development and test environments are not tracked unless you set the variable there.

If you have more than one HTML layout (for example application.html.erb and admin.html.erb), add the tag to each, or move it into a partial such as app/views/layouts/_rybbit.html.erb and <%= render "layouts/rybbit" %> from every layout. Mailer layouts do not need it.

Turbo and Hotwire

Turbo Drive replaces the page <body> on each visit, merges the <head>, and pushes the new URL with history.pushState. The Rybbit script hooks history.pushState and history.replaceState and listens for popstate and hashchange, so every Turbo visit is tracked as a pageview while SPA Navigation is enabled in your site settings (the default). No turbo:load listener is needed. Because the script tag is in <head> and identical on every page, Turbo Drive keeps the existing tag instead of loading it again.

Verify installation

Open your live site in a new tab and click through a few pages. Within a few seconds the pageviews appear in the Rybbit dashboard.

If nothing shows up:

View the page source and search for script.js?siteId= to confirm the snippet is on the page.
Open the browser Network tab and check that script.js returns 200 and that POST requests go to /api/track.
Disable ad blockers, or set up a proxy so the script loads from your own domain.
See the script troubleshooting guide for other common causes.

Troubleshooting

Tag missing: config/application.rb is read once at boot, so restart the server after changing RYBBIT_SITE_ID. Check Rails.configuration.x.rybbit.site_id in rails console if the tag does not render.
Content Security Policy: if you set a policy in config/initializers/content_security_policy.rb, add your Rybbit host to script_src and connect_src, or the browser blocks both the script and the /api/track requests. Alternatively proxy the script through your own domain so no extra origin is needed.
Self-hosted instance: set RYBBIT_INSTANCE_URL to your own domain without a trailing slash; the layout appends the script path to it.

Next steps

Track custom events such as signups, purchases and button clicks.
Identify users to connect sessions to accounts.
Proxy the script through your own domain to bypass ad blockers.
Script attributes let you skip or mask URLs and tag events.

On this page