Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/greengerong/prerender-java
java framework for prerender
https://github.com/greengerong/prerender-java
angular1 crawler java prerender prerendered-page seo
Last synced: 26 days ago
JSON representation
java framework for prerender
- Host: GitHub
- URL: https://github.com/greengerong/prerender-java
- Owner: greengerong
- License: mit
- Created: 2013-10-15T14:48:26.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2023-07-09T08:28:03.000Z (over 1 year ago)
- Last Synced: 2024-09-28T17:22:30.237Z (about 1 month ago)
- Topics: angular1, crawler, java, prerender, prerendered-page, seo
- Language: Java
- Homepage: http://prerender.io/
- Size: 165 KB
- Stars: 121
- Watchers: 11
- Forks: 48
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
Prerender Java
===========================
Are you using backbone, angular, emberjs, etc, but you're unsure about the SEO implications?
Use this java filter that prerenders a javascript-rendered page using an external service and returns the HTML to the search engine crawler for SEO.
`Note:` If you are using a `#` in your urls, make sure to change it to `#!`. [View Google's ajax crawling protocol](https://developers.google.com/webmasters/ajax-crawling/docs/getting-started)
`Note:` Make sure you have more than one webserver thread/process running because the prerender service will make a request to your server to render the HTML.
1:Add this line to your web.xml:
prerender
com.github.greengerong.PreRenderSEOFilter
prerenderToken
[get from prerender: https://prerender.io/]
prerender
/*
2:add dependency on your project pom:
com.github.greengerong
prerender-java
1.6.4
## How it works
1. Check to make sure we should show a prerendered page
1. Check if the request is from a crawler (`_escaped_fragment_` or agent string)
2. Check to make sure we aren't requesting a resource (js, css, etc...)
3. (optional) Check to make sure the url is in the whitelist
4. (optional) Check to make sure the url isn't in the blacklist
2. Make a `GET` request to the [prerender service](https://github.com/prerender/prerender)(phantomjs server) for the page's prerendered HTML
3. Return that HTML to the crawler
## Customization
### crawlerUserAgents
example: someproxy,someproxy1
### whitelist
### blacklist
### forwardedURLHeader
Important for servers behind reverse proxy that need the public url to be used for pre-rendering.
We usually set the original url in an http header which is added by the reverse proxy (similar to the more standard `x-forwarded-proto` and `x-forwarded-for`)
### protocol
If you specifically want to make sure that the Prerender service queries using https or http protocol, you can set the init-param `protocol` to `https` or `http` respectively.
### Using your own prerender service
If you've deployed the prerender service on your own, set the `PRERENDER_SERVICE_URL` environment variable so that this package points there instead. Otherwise, it will default to the service already deployed at `http://service.prerender.io/`
$ export PRERENDER_SERVICE_URL=
Or on heroku:
$ heroku config:add PRERENDER_SERVICE_URL=
As an alternative, you can pass `prerender_service_url` in the options object during initialization of the middleware
``` xml
config filter init param with "prerenderServiceUrl";
```
### prerender service token
If you want to use token with the prerender service, you can config it.
``` xml
config filter init param with "prerenderToken";
```
### prerender event handler
If you want to cache the caching, analytics, log or others, you can config it. It should be instance of "com.github.greengerong.PreRenderEventHandler"
``` xml
config filter init param with "preRenderEventHandler";
```
## Testing
If your URLs use a hash-bang:
If you want to see `http://localhost:3000/#!/profiles/1234`
Then go to `http://localhost:3000/?_escaped_fragment_=/profiles/1234`
If your URLs use push-state:
If you want to see `http://localhost:3000/profiles/1234`
Then go to `http://localhost:3000/profiles/1234?_escaped_fragment_=`
project demo test url:
http://localhost:8080/test/?_escaped_fragment_=
## License
The MIT License (MIT)