Add whitelistUserAgents option

jotto · jotto · commit 63380456d4b4 · 2019-01-21T22:22:52.000-05:00
diff --git a/handler.js b/handler.js
@@ -63,7 +63,12 @@ const resetPrerenderCloud = () => {
   //    generally not recommended due to potential google SEO cloaking penalties no one fully understands
   // prerendercloud.set("botsOnly", true);
 
-  // 7. metaOnly
+  // 7. whitelistUserAgents
+  //    specify your own list of bots
+  //    useful when you only care about open graph previews (in which case, metaOnly also makes sense)
+  // prerendercloud.set('whitelistUserAgents', ['twitterbot', 'slackbot', 'facebookexternalhit']);
+
+  // 8. metaOnly
   //    only prerender the <title> and <meta> tags in the <head> section. The returned HTML payload will otherwise be unmodified.
   //    useful if you don't care about server-side rendering but want open-graph previews to work everywhere
   //    must be a function that receives a req object, and returns a bool
@@ -72,7 +77,7 @@ const resetPrerenderCloud = () => {
   // eg2:
   //   prerendercloud.set('metaOnly', () => true);
 
-  // 8. disableServerCache
+  // 9. disableServerCache
   //    Disable the cache on prerender.cloud (default is enabled with 5 minute duration).
   //    It probably makes sense to disable the prerender.cloud server cache
   //    since CloudFront is caching things for you.
@@ -85,21 +90,21 @@ const resetPrerenderCloud = () => {
   //           things down unnecessarily)
   // prerendercloud.set('disableServerCache', true);
 
-  // 9. blacklistPaths
+  // 10. blacklistPaths
   //    the viewer-request function can't see what files exist on origin so you may need this
   //    if you have HTML files that should not be pre-rendered (e.g. google/apple/fb verification files)
   //    trailing * works as a wildcard
   // prerendercloud.set('blacklistPaths', req => ['/facebook-domain-verification.html', '/signin/*', '/google*']);
 
-  // 10. removeScriptsTag (not recommended)
+  // 11. removeScriptsTag (not recommended)
   //    Removes all scripts/JS, useful if:
   //      - trying to get under 1MB Lambda@Edge limit
   //      - having problems with your JS app taking over from the pre-rendered content
   //    Huge caveat: this also means your app will no longer be a "single-page app" since
   //    all of the JavaScript will be gone
   // prerendercloud.set("removeScriptTags", true);
 
-  // 11. disableAjaxPreload
+  // 12. disableAjaxPreload
   //    "Ajax Preload" is a monkey-patch, included by default when metaOnly is false/null.
   //     It prevents screen flicker/repaint/flashing, but increases initial page load size
   //     (because it embeds the AJAX responses into your HTML).
@@ -113,7 +118,7 @@ const resetPrerenderCloud = () => {
   //       - https://github.com/sanfrancesco/prerendercloud-ajaxmonkeypatch
   // prerendercloud.set("disableAjaxPreload", true);
 
-  // 12. see all configuration options here: https://github.com/sanfrancesco/prerendercloud-nodejs
+  // 13. see all configuration options here: https://github.com/sanfrancesco/prerendercloud-nodejs
 
   // for tests
   if (prerenderCloudOption) prerenderCloudOption(prerendercloud);
