Skip to content

General settings (VUUKLE_CONFIG)

VUUKLE_CONFIG is the global object every Vuukle widget reads from. You set it once per page and the script handles initialization.

The shape is intentionally small. Per-site behaviour — theme, login methods, character limits, sort order, moderation thresholds, emote images, translations — is managed from the dashboard, not from this config. The browser only knows things the server doesn’t: which article you’re on, what its title is, what its image is.

The complete browser-side schema

<script>
var VUUKLE_CONFIG = {
apiKey: 'YOUR_PUBLIC_API_KEY', // required
articleId: 'post-12345', // optional — falls back to page URL
title: 'Article title',
url: 'https://example.com/article-slug',
img: 'https://example.com/img/article.jpg',
tags: 'tag1, tag2, tag3',
author: 'Article author',
};
</script>
<script src="https://cdn.vuukle.com/platform.js" async></script>
KeyTypeRequiredDescription
apiKeystringYesPublic API key from Integration → API Key in the dashboard.
articleIdstring | numberOptionalUnique identifier per article — stable across page loads. Falls back to the page URL if omitted. Recommended for sites where URLs can change.
titlestringRecommendedArticle title — used in shared URLs and OG previews.
urlstringRecommendedCanonical article URL.
imgstringRecommendedArticle hero image URL.
tagsstringOptionalComma-separated tags for analytics and recommendations.
authorstringOptionalAuthor name.

What’s not here (and where to find it)

These options used to live in VUUKLE_CONFIG but are now managed entirely from the dashboard:

Old config keyWhere it lives now
theme.color, theme.darkModeSite Settings → Comment Widget → Theme
comments.maxCharsSite Settings → Comment Widget → Character limit
comments.sortingSite Settings → Comment Widget → Default sort
comments.countToLoadSite Settings → Comment Widget → Initial count
comments.toxicityLimit, spamLimitSite Settings → Comment Widget → Moderation
comments.auth.{facebook,google,…}Site Settings → Comment Widget → Login methods
comments.editorOptionsSite Settings → Comment Widget → Editor
emotes.firstImg, firstName, etc.Site Settings → Emote settings
emotes.disable, sizeSite Settings → Emote settings
powerbar.defaultEmote, verticalPositionSite Settings → ShareBar Settings
languageAuto-detected from the visitor’s locale; specific overrides in the dashboard
wordpressSyncHandled automatically by the WordPress plugin

The one exception is SSO — it’s still wired browser-side because it has to call a function you control:

<script>
var VUUKLE_CONFIG = {
apiKey: 'YOUR_PUBLIC_API_KEY',
articleId: 'post-12345',
comments: {
auth: {
sso: { onClick: openYourLoginModal },
},
},
};
</script>
<script src="https://cdn.vuukle.com/platform.js" async></script>

See SSO overview.

Comments widget

Where to configure login methods, moderation, theme. Comments →

Dashboard tour

What lives where in the publisher dashboard. Tour →

VUUKLE_CONFIG reference

Complete schema in one page. Reference →

Was this page helpful?
Help us improve — drop a note or open the dashboard.