# Configuring and troubleshooting oneboxes

**URL:** https://meta.discourse.org/t/configuring-and-troubleshooting-oneboxes/239715
**Category:** Site Management
**Tags:** onebox, how-to, content
**Created:** [September 22, 2022, 1:28am UTC](https://meta.discourse.org/t/configuring-and-troubleshooting-oneboxes/239715 "2022-09-22T01:28:48Z")
**Posts on this page:** 3
**Page:** 1

<div class="post-metadata">

### Author: ![Discourse](https://sea3.discourse-cdn.com/meta/user_avatar/meta.discourse.org/discourse/32/148734_2.png) [@Discourse](https://meta.discourse.org/u/Discourse)
#### Post date: [September 22, 2022, 1:28am UTC](https://meta.discourse.org/t/configuring-and-troubleshooting-oneboxes/239715/1 "2022-09-22T01:28:48Z")

</div>

> 🔖 This guide explains how to configure and troubleshoot oneboxes in Discourse. It covers admin settings, how oneboxes work, and steps to resolve common issues.
> 
> 🙋 Required user level: Administrator

Oneboxes are rich link previews that users can create in their posts. While users can easily generate these previews, site administrators have additional controls and may need to troubleshoot when links don’t preview as expected.

## Admin configuration

To manage onebox settings:

1. Go to the Admin panel
2. Navigate to the site settings section
3. Search for “onebox”

You’ll see a list of onebox-related settings:

 ![image](https://global.discourse-cdn.com/meta/original/4X/5/1/f/51f218928297981d9f4168869a30f00b1d74a53f.png)

Some notable settings include:

- `post onebox maxlength`: Controls the amount of text included in a onebox
- `max oneboxes per post`: Limits the number of oneboxes that can appear in a single post (default: 50)
- `enable inline onebox on all domains`: Enables inline oneboxes on all domains, converting plain URLs to linked titles (e.g., `https://en.wikipedia.org/wiki/Fun_(band)` becomes “Fun (band) - Wikipedia”). This is enabled by default.
- `blocked onebox domains`: Allows you to disable oneboxes for specific domains
- `block onebox on redirect`: When enabled, prevents oneboxing URLs that redirect to a different destination

## How oneboxes work

When a link is included in a post, Discourse visits the destination page and looks for [Open Graph](http://ogp.me/) or [oEmbed](https://oembed.com/) tags, including:

- Site address
- Title
- Featured image
- Site icon (or favicon)
- Description (mandatory)
- Product price (if relevant)

> ⚠ Discourse requires the description tag to be present and contain enough text to summarize the page. Without this, the target link will not onebox.

Here’s an example onebox for [https://discourse.org](https://discourse.org) that shows the site title, featured image, icon, and description:

> **[Where Tech Companies Build Communities](https://discourse.org/)**
>
> The customizable, scalable community platform powering over 22,000 communities. Create knowledge through conversation.

## Troubleshooting

If oneboxes aren’t working as expected, try these steps:

1. Test the site using [iFramely](https://iframely.com/embed):

2. Check if the onebox request is being blocked:

3. For internal links not displaying as oneboxes:

From the rails console you can explicitly invalidate/fetch oneboxes by calling [the methods](https://github.com/discourse/discourse/blob/main/lib/oneboxer.rb) while testing by doing:

```plaintext
[1] pry(main)> Oneboxer.invalidate(url)
=> 0

[2] pry(main)> Oneboxer.onebox(url)
=> "<aside class=\"onebox …(elided)"

[3] pry(main)> InlineOneboxer.invalidate(url)
=> 0

[4] pry(main)> InlineOneboxer.lookup(url)
=> {url: "https://example.com", title: "Example Page Title"}

```

## Additional resources

- [Creating rich link previews with Onebox](https://meta.discourse.org/t/create-rich-link-previews-with-onebox/98088?silent=true)

> Last edited by @olivia 2025-12-31T10:27:39Z
> 
> > **Check document**
> >
> > Perform check on document:

---

<div class="post-metadata">

### Author: ![anon48433008](https://avatars.discourse-cdn.com/v4/letter/a/22d042/32.png) [@anon48433008](https://meta.discourse.org/u/anon48433008)
#### Post date: [July 17, 2024, 2:01pm UTC](https://meta.discourse.org/t/configuring-and-troubleshooting-oneboxes/239715/2 "2024-07-17T14:01:23Z")

</div>

> [@Discourse](#):
>
> Discourse requires the description tag to be present and contain enough text to summarize the page

This is a good resource but seems to fall short

> [@Discourse](#):
>
> Test the site using [iFramely](https://iframely.com/embed)

I did this and it returned a one box, it was light on contents but still looked better than a simple url link

Assuming its being light on content is the issue for it not one boxing on my site based on it not meeting this requirement what can be done?

> [@Discourse](#):
>
> contain enough text to summarize

I don’t see a setting to one box sites that don’t have enough content, so then can a site admin be contacted to make a change on their end, if so what needs to be asked?

How does it help solve the issue of not one boxing?

---

<div class="post-metadata">

### Author: ![Dmitry\_Krasnoperov](https://sea3.discourse-cdn.com/meta/user_avatar/meta.discourse.org/dmitry_krasnoperov/32/65079_2.png) [@Dmitry\_Krasnoperov](https://meta.discourse.org/u/Dmitry_Krasnoperov)
#### Post date: [June 26, 2026, 9:49pm UTC](https://meta.discourse.org/t/configuring-and-troubleshooting-oneboxes/239715/3 "2026-06-26T21:49:14Z")

</div>

> **[Kakashi by Yasuaki Shimizu](https://album.link/s/0ZVkkcvhUWQ4hIeoC8Y5Kb)**
>
> Listen now on your favorite streaming service. Powered by Songlink/Odesli, an on-demand, customizable smart link service to help you share songs, albums, podcasts and more.

What could the reason that album.link doesn’t work for my site?
