Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Instructions for Modifying User Agent List #196

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add Instructions for Modifying User Agent List #196

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,31 @@ Option to add options to the request sent to the prerender server.
app.use(require('prerender-node').set('prerenderServerRequestOptions', {}));
```

### `crawlerUserAgents` and `extensionsToIgnore`

`prerender.crawlerUserAgents` and `prerender.extensionsToIgnore` can be customized simply by editing the data from the module directly after import. For example, to add user agents:

```js
var prerender = require('prerender-node');
prerender.crawlerUserAgents.push("useragent1", "useragent2");
app.use(prerender);
```

To remove certain user agents:

```js
var prerender = require('prerender-node');
prerender.crawlerUserAgents = prerender.crawlerUserAgents.filter(function(ua) { return ua !== 'googlebot'; });
app.use(prerender);
```

Or, to completely replace the list with your own:

```js
var prerender = require('prerender-node');
prerender.crawlerUserAgents = [ 'facebookexternalhit' ]; //add any other user agents you'd like to support
app.use(prerender);
```

## Caching

Expand Down